Give records a reference to the model manager which loaded them #754
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "name": "@gadgetinc/api-client-core", | ||
| "version": "0.15.39", | ||
| "files": [ | ||
| "Readme.md", | ||
| "dist/**/*" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| import type { GadgetConnection } from "./GadgetConnection.js"; | ||
| import type { FindFirstFunction, FindManyFunction, FindOneFunction, GetFunction } from "./GadgetFunctions.js"; | ||
| import type { GadgetRecord } from "./GadgetRecord.js"; | ||
| import type { InternalModelManager } from "./InternalModelManager.js"; | ||
|
|
||
| export type AnyModelFinderMetadata = { | ||
| /** The name of the GraphQL API field that should be called for this operation */ | ||
| operationName: string; | ||
| /** The model's api identifier */ | ||
| modelApiIdentifier: string; | ||
| /** What fields to select from the GraphQL API if no explicit selection is passed */ | ||
| defaultSelection: Record<string, any>; | ||
| /** A namespace this operation is nested in. Absent for old clients or root-namespaced operations */ | ||
| namespace?: string | string[] | null; | ||
| /** Type-time only type member used for strong typing of finders */ | ||
| selectionType: any; | ||
| /** Type-time only type member used for strong typing of finders */ | ||
| optionsType: any; | ||
| /** Type-time only type member used for strong typing of finders */ | ||
| schemaType: any | null; | ||
| }; | ||
|
|
||
| export type AnyFindOneFunc = FindOneFunction<any, any, any, any>; | ||
| export type AnyFindManyFunc = FindManyFunction<any, any, any, any>; | ||
| export type AnyFindFirstFunc = FindFirstFunction<any, any, any, any>; | ||
|
|
||
| /** | ||
| * The manager class for a given model that uses the Public API, like `api.post` or `api.user` | ||
| **/ | ||
| export interface AnyPublicModelManager< | ||
| FindOneFunc extends AnyFindOneFunc = AnyFindOneFunc, | ||
| FindManyFunc extends AnyFindManyFunc = AnyFindManyFunc, | ||
| FindFirstFunc extends AnyFindFirstFunc = AnyFindFirstFunc | ||
| > { | ||
| connection: GadgetConnection; | ||
| findOne: FindOneFunc; | ||
| findMany: FindManyFunc; | ||
| findFirst: FindFirstFunc; | ||
| maybeFindFirst(options: any): Promise<GadgetRecord<any> | null>; | ||
| maybeFindOne(id: string, options: any): Promise<GadgetRecord<any> | null>; | ||
| } | ||
|
|
||
| /** | ||
| * The manager class for a given single model that uses the Public API, like `api.session` | ||
| **/ | ||
| export interface AnyPublicSingletonModelManager<GetFunc extends GetFunction<any, any, any, any> = GetFunction<any, any, any, any>> { | ||
| connection: GadgetConnection; | ||
| get: GetFunc; | ||
| } | ||
|
|
||
| /** | ||
| * Prior to 1.1 actions were defined to accept just a connection | ||
| */ | ||
| export interface AnyLegacyModelManager { | ||
|
There was a problem hiding this comment. This is to address a test case inside |
||
| connection: GadgetConnection; | ||
| } | ||
|
|
||
| /** | ||
| * Any model manager, either public or internal | ||
| */ | ||
| export type AnyModelManager = AnyPublicModelManager | AnyPublicSingletonModelManager | AnyLegacyModelManager | InternalModelManager; | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is kind of unfortunate but addresses an issue with
useSessionanduseAuthtyping. For both these react hooks we accept a type that is:js-clients/packages/react/src/auth/useAuth.ts
Lines 21 to 22 in e3773e9
Which scopes the client down to one that has both
userfindManyfunction and asessionwith agetfunction. This is narrowing the type of theModelManagerand the resulting object is then typed to be aGadgetRecordbased on the input client/model manager. In order to make it play nicely with hydration and keeping the reference to the model manager I want to also add theAnyPublicModelManagerorAnyPublicSingletonModelManagerinterface too. I had changed it to be:however this leads to an infinite typing/complexity error getting the output
GadgetRecordtype. To address this I have added these optional generic typings to allow the function typing to be passed through. This way thegetandfindManyfunction types can be passed through and the resulting type can be inferred again.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awkward but this makes sense