Skip to content

Commit 31ca8c0

Browse files
wschurmanwschurman
committed
feat: add PostgresEntity/ReadonlyPostgresEntity classes that expose knexLoader methods
1 parent 51d632d commit 31ca8c0

4 files changed

Lines changed: 405 additions & 0 deletions

File tree

‎packages/entity-database-adapter-knex/src/PostgresEntity.ts‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
import {
2+
Entity,
3+
EntityPrivacyPolicy,
4+
EntityQueryContext,
5+
IEntityClass,
6+
ReadonlyEntity,
7+
ViewerContext,
8+
} from '@expo/entity';
9+
10+
import { AuthorizationResultBasedKnexEntityLoader } from './AuthorizationResultBasedKnexEntityLoader';
11+
import { EnforcingKnexEntityLoader } from './EnforcingKnexEntityLoader';
12+
import {
13+
knexLoader as knexLoaderFn,
14+
knexLoaderWithAuthorizationResults as knexLoaderWithAuthorizationResultsFn,
15+
} from './knexLoader';
16+
17+
/**
18+
* Abstract base class for mutable entities backed by Postgres.
19+
* Provides `knexLoader` and `knexLoaderWithAuthorizationResults` as inherited static methods,
20+
* in addition to the mutation methods inherited from `Entity`.
21+
*/
22+
export abstract class PostgresEntity<
23+
TFields extends Record<string, any>,
24+
TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>,
25+
TViewerContext extends ViewerContext,
26+
TSelectedFields extends keyof TFields = keyof TFields,
27+
> extends Entity<TFields, TIDField, TViewerContext, TSelectedFields> {
28+
/**
29+
* Vend knex loader for loading entities via knex-specific methods in a given query context.
30+
*
31+
* @param viewerContext - viewer context of loading user
32+
* @param queryContext - query context in which to perform the load
33+
*/
34+
static knexLoader<
35+
TMFields extends object,
36+
TMIDField extends keyof NonNullable<Pick<TMFields, TMSelectedFields>>,
37+
TMViewerContext extends ViewerContext,
38+
TMEntity extends ReadonlyEntity<TMFields, TMIDField, TMViewerContext, TMSelectedFields>,
39+
TMPrivacyPolicy extends EntityPrivacyPolicy<
40+
TMFields,
41+
TMIDField,
42+
TMViewerContext,
43+
TMEntity,
44+
TMSelectedFields
45+
>,
46+
TMSelectedFields extends keyof TMFields = keyof TMFields,
47+
>(
48+
this: IEntityClass<
49+
TMFields,
50+
TMIDField,
51+
TMViewerContext,
52+
TMEntity,
53+
TMPrivacyPolicy,
54+
TMSelectedFields
55+
>,
56+
viewerContext: TMViewerContext,
57+
queryContext: EntityQueryContext = viewerContext
58+
.getViewerScopedEntityCompanionForClass(this)
59+
.getQueryContextProvider()
60+
.getQueryContext(),
61+
): EnforcingKnexEntityLoader<
62+
TMFields,
63+
TMIDField,
64+
TMViewerContext,
65+
TMEntity,
66+
TMPrivacyPolicy,
67+
TMSelectedFields
68+
> {
69+
return knexLoaderFn(this, viewerContext, queryContext);
70+
}
71+
72+
/**
73+
* Vend knex loader for loading entities via knex-specific methods in a given query context.
74+
* Returns authorization results instead of throwing on authorization errors.
75+
*
76+
* @param viewerContext - viewer context of loading user
77+
* @param queryContext - query context in which to perform the load
78+
*/
79+
static knexLoaderWithAuthorizationResults<
80+
TMFields extends object,
81+
TMIDField extends keyof NonNullable<Pick<TMFields, TMSelectedFields>>,
82+
TMViewerContext extends ViewerContext,
83+
TMEntity extends ReadonlyEntity<TMFields, TMIDField, TMViewerContext, TMSelectedFields>,
84+
TMPrivacyPolicy extends EntityPrivacyPolicy<
85+
TMFields,
86+
TMIDField,
87+
TMViewerContext,
88+
TMEntity,
89+
TMSelectedFields
90+
>,
91+
TMSelectedFields extends keyof TMFields = keyof TMFields,
92+
>(
93+
this: IEntityClass<
94+
TMFields,
95+
TMIDField,
96+
TMViewerContext,
97+
TMEntity,
98+
TMPrivacyPolicy,
99+
TMSelectedFields
100+
>,
101+
viewerContext: TMViewerContext,
102+
queryContext: EntityQueryContext = viewerContext
103+
.getViewerScopedEntityCompanionForClass(this)
104+
.getQueryContextProvider()
105+
.getQueryContext(),
106+
): AuthorizationResultBasedKnexEntityLoader<
107+
TMFields,
108+
TMIDField,
109+
TMViewerContext,
110+
TMEntity,
111+
TMPrivacyPolicy,
112+
TMSelectedFields
113+
> {
114+
return knexLoaderWithAuthorizationResultsFn(this, viewerContext, queryContext);
115+
}
116+
}

‎packages/entity-database-adapter-knex/src/ReadonlyPostgresEntity.ts‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
import {
2+
EntityPrivacyPolicy,
3+
EntityQueryContext,
4+
IEntityClass,
5+
ReadonlyEntity,
6+
ViewerContext,
7+
} from '@expo/entity';
8+
9+
import { AuthorizationResultBasedKnexEntityLoader } from './AuthorizationResultBasedKnexEntityLoader';
10+
import { EnforcingKnexEntityLoader } from './EnforcingKnexEntityLoader';
11+
import {
12+
knexLoader as knexLoaderFn,
13+
knexLoaderWithAuthorizationResults as knexLoaderWithAuthorizationResultsFn,
14+
} from './knexLoader';
15+
16+
/**
17+
* Abstract base class for readonly entities backed by Postgres.
18+
* Provides `knexLoader` and `knexLoaderWithAuthorizationResults` as inherited static methods.
19+
*
20+
* Entities that should not be mutated (e.g., representing SQL views or immutable tables)
21+
* can extend this class instead of `ReadonlyEntity` to get knex loader ergonomics.
22+
*/
23+
export abstract class ReadonlyPostgresEntity<
24+
TFields extends Record<string, any>,
25+
TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>,
26+
TViewerContext extends ViewerContext,
27+
TSelectedFields extends keyof TFields = keyof TFields,
28+
> extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields> {
29+
/**
30+
* Vend knex loader for loading entities via non-data-loader methods in a given query context.
31+
* @param viewerContext - viewer context of loading user
32+
* @param queryContext - query context in which to perform the load
33+
*/
34+
static knexLoader<
35+
TMFields extends object,
36+
TMIDField extends keyof NonNullable<Pick<TMFields, TMSelectedFields>>,
37+
TMViewerContext extends ViewerContext,
38+
TMEntity extends ReadonlyEntity<TMFields, TMIDField, TMViewerContext, TMSelectedFields>,
39+
TMPrivacyPolicy extends EntityPrivacyPolicy<
40+
TMFields,
41+
TMIDField,
42+
TMViewerContext,
43+
TMEntity,
44+
TMSelectedFields
45+
>,
46+
TMSelectedFields extends keyof TMFields = keyof TMFields,
47+
>(
48+
this: IEntityClass<
49+
TMFields,
50+
TMIDField,
51+
TMViewerContext,
52+
TMEntity,
53+
TMPrivacyPolicy,
54+
TMSelectedFields
55+
>,
56+
viewerContext: TMViewerContext,
57+
queryContext: EntityQueryContext = viewerContext
58+
.getViewerScopedEntityCompanionForClass(this)
59+
.getQueryContextProvider()
60+
.getQueryContext(),
61+
): EnforcingKnexEntityLoader<
62+
TMFields,
63+
TMIDField,
64+
TMViewerContext,
65+
TMEntity,
66+
TMPrivacyPolicy,
67+
TMSelectedFields
68+
> {
69+
return knexLoaderFn(this, viewerContext, queryContext);
70+
}
71+
72+
/**
73+
* Vend knex loader for loading entities via non-data-loader methods in a given query context.
74+
* Returns authorization results instead of throwing on authorization errors.
75+
* @param viewerContext - viewer context of loading user
76+
* @param queryContext - query context in which to perform the load
77+
*/
78+
static knexLoaderWithAuthorizationResults<
79+
TMFields extends object,
80+
TMIDField extends keyof NonNullable<Pick<TMFields, TMSelectedFields>>,
81+
TMViewerContext extends ViewerContext,
82+
TMEntity extends ReadonlyEntity<TMFields, TMIDField, TMViewerContext, TMSelectedFields>,
83+
TMPrivacyPolicy extends EntityPrivacyPolicy<
84+
TMFields,
85+
TMIDField,
86+
TMViewerContext,
87+
TMEntity,
88+
TMSelectedFields
89+
>,
90+
TMSelectedFields extends keyof TMFields = keyof TMFields,
91+
>(
92+
this: IEntityClass<
93+
TMFields,
94+
TMIDField,
95+
TMViewerContext,
96+
TMEntity,
97+
TMPrivacyPolicy,
98+
TMSelectedFields
99+
>,
100+
viewerContext: TMViewerContext,
101+
queryContext: EntityQueryContext = viewerContext
102+
.getViewerScopedEntityCompanionForClass(this)
103+
.getQueryContextProvider()
104+
.getQueryContext(),
105+
): AuthorizationResultBasedKnexEntityLoader<
106+
TMFields,
107+
TMIDField,
108+
TMViewerContext,
109+
TMEntity,
110+
TMPrivacyPolicy,
111+
TMSelectedFields
112+
> {
113+
return knexLoaderWithAuthorizationResultsFn(this, viewerContext, queryContext);
114+
}
115+
}

0 commit comments

Comments
 (0)