diff --git a/.changeset/brown-ways-compare.md b/.changeset/brown-ways-compare.md deleted file mode 100644 index e495278d..00000000 --- a/.changeset/brown-ways-compare.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@tanstack-query-firebase/angular": patch ---- - -Fix issue where signal updates weren't getting picked up diff --git a/dataconnect-sdk/js/default-connector/.guides/config.json b/dataconnect-sdk/js/default-connector/.guides/config.json new file mode 100644 index 00000000..e37ed06f --- /dev/null +++ b/dataconnect-sdk/js/default-connector/.guides/config.json @@ -0,0 +1,9 @@ +{ + "description": "A set of guides for interacting with the generated firebase dataconnect sdk", + "mcpServers": { + "firebase": { + "command": "npx", + "args": ["-y", "firebase-tools@latest", "experimental:mcp"] + } + } +} diff --git a/dataconnect-sdk/js/default-connector/.guides/setup.md b/dataconnect-sdk/js/default-connector/.guides/setup.md new file mode 100644 index 00000000..2425dd82 --- /dev/null +++ b/dataconnect-sdk/js/default-connector/.guides/setup.md @@ -0,0 +1,20 @@ +# Setup + +If the user hasn't already installed the SDK, always run the user's node package manager of choice, and install the package in the directory ../package.json. +For more information on where the library is located, look at the connector.yaml file. + +```ts +import { initializeApp } from 'firebase/app'; + +initializeApp({ + // fill in your project config here using the values from your Firebase project or from the `firebase_get_sdk_config` tool from the Firebase MCP server. +}); +``` + +Then, you can run the SDK as needed. +```ts +import { ... } from '@dataconnect/default-connector'; +``` + + + diff --git a/dataconnect-sdk/js/default-connector/.guides/usage.md b/dataconnect-sdk/js/default-connector/.guides/usage.md new file mode 100644 index 00000000..f634ca28 --- /dev/null +++ b/dataconnect-sdk/js/default-connector/.guides/usage.md @@ -0,0 +1,45 @@ +# Basic Usage + +Always prioritize using a supported framework over using the generated SDK +directly. Supported frameworks simplify the developer experience and help ensure +best practices are followed. + + + + + +## Advanced Usage +If a user is not using a supported framework, they can use the generated SDK directly. + +Here's an example of how to use it with the first 5 operations: + +```js +import { createMovie, upsertMovie, deleteMovie, addMeta, deleteMeta, listMovies, getMovieById, getMeta } from '@dataconnect/default-connector'; + + +// Operation CreateMovie: For variables, look at type CreateMovieVars in ../index.d.ts +const { data } = await CreateMovie(dataConnect, createMovieVars); + +// Operation UpsertMovie: For variables, look at type UpsertMovieVars in ../index.d.ts +const { data } = await UpsertMovie(dataConnect, upsertMovieVars); + +// Operation DeleteMovie: For variables, look at type DeleteMovieVars in ../index.d.ts +const { data } = await DeleteMovie(dataConnect, deleteMovieVars); + +// Operation AddMeta: +const { data } = await AddMeta(dataConnect); + +// Operation DeleteMeta: For variables, look at type DeleteMetaVars in ../index.d.ts +const { data } = await DeleteMeta(dataConnect, deleteMetaVars); + +// Operation ListMovies: +const { data } = await ListMovies(dataConnect); + +// Operation GetMovieById: For variables, look at type GetMovieByIdVars in ../index.d.ts +const { data } = await GetMovieById(dataConnect, getMovieByIdVars); + +// Operation GetMeta: +const { data } = await GetMeta(dataConnect); + + +``` \ No newline at end of file diff --git a/packages/angular/CHANGELOG.md b/packages/angular/CHANGELOG.md index 188e829f..db1e8ec7 100644 --- a/packages/angular/CHANGELOG.md +++ b/packages/angular/CHANGELOG.md @@ -1,5 +1,11 @@ # @tanstack-query-firebase/angular +## 1.0.3 + +### Patch Changes + +- ee67d1e: Fix issue where signal updates weren't getting picked up + ## 1.0.2 ### Patch Changes diff --git a/packages/angular/package.json b/packages/angular/package.json index 61e06e41..1a40923f 100644 --- a/packages/angular/package.json +++ b/packages/angular/package.json @@ -1,6 +1,6 @@ { "name": "@tanstack-query-firebase/angular", - "version": "1.0.2", + "version": "1.0.3", "description": "TanStack Query bindings for Firebase and Angular", "type": "module", "scripts": {