Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optional namespace #24

Merged
merged 4 commits into from
Dec 2, 2024
Merged

optional namespace #24

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e2c196
optional namespace
ianmacartney Dec 1, 2024
61b59c5
update package lock
ianmacartney Dec 2, 2024
d571aed
do the same for DirectAggregate
ianmacartney Dec 2, 2024
4b38aa5
update readme
ianmacartney Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions example/convex/leaderboard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,17 @@ export const migrations = new Migrations<DataModel>(components.migrations);
export const run = migrations.runner();

const aggregateByScore = new TableAggregate<{
Namespace: undefined;
Key: number;
DataModel: DataModel;
TableName: "leaderboard";
}>(components.aggregateByScore, {
namespace: (_doc) => undefined,
sortKey: (doc) => doc.score,
});
const aggregateScoreByUser = new TableAggregate<{
Key: [string, number];
DataModel: DataModel;
TableName: "leaderboard";
Namespace: undefined;
}>(components.aggregateScoreByUser, {
namespace: (_doc) => undefined,
sortKey: (doc) => [doc.name, doc.score],
sumValue: (doc) => doc.score,
});
Expand Down
2 changes: 0 additions & 2 deletions example/convex/shuffle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ import Rand from "rand-seed";
const randomize = new TableAggregate<{
DataModel: DataModel;
TableName: "music";
Namespace: undefined;
Key: null;
}>(components.music, {
namespace: () => undefined,
sortKey: () => null,
});

Expand Down
24 changes: 12 additions & 12 deletions example/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 27 additions & 15 deletions src/client/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,19 +622,22 @@ export type TableAggregateType<
K extends Key,
DataModel extends GenericDataModel,
TableName extends TableNamesInDataModel<DataModel>,
Namespace extends ConvexValue | undefined,
Namespace extends ConvexValue | undefined = undefined,
> = {
Key: K;
DataModel: DataModel;
TableName: TableName;
Namespace: Namespace;
Namespace?: Namespace;
};

type AnyTableAggregateType = TableAggregateType<
Key,
GenericDataModel,
TableNamesInDataModel<GenericDataModel>,
ConvexValue | undefined
>;
type TableAggregateNamespace<T extends AnyTableAggregateType> =
"Namespace" extends keyof T ? T["Namespace"] : undefined;
type TableAggregateDocument<T extends AnyTableAggregateType> = DocumentByName<
T["DataModel"],
T["TableName"]
Expand All @@ -651,15 +654,24 @@ type TableAggregateTrigger<Ctx, T extends AnyTableAggregateType> = Trigger<
export class TableAggregate<T extends AnyTableAggregateType> extends Aggregate<
T["Key"],
GenericId<T["TableName"]>,
T["Namespace"]
TableAggregateNamespace<T>
> {
constructor(
component: UsedAPI,
private options: {
namespace: (d: TableAggregateDocument<T>) => T["Namespace"];
sortKey: (d: TableAggregateDocument<T>) => T["Key"];
sumValue?: (d: TableAggregateDocument<T>) => number;
}
} & (undefined extends TableAggregateNamespace<T>
? {
namespace?: (
d: TableAggregateDocument<T>
) => TableAggregateNamespace<T>;
}
: {
namespace: (
d: TableAggregateDocument<T>
) => TableAggregateNamespace<T>;
})
) {
super(component);
}
Expand All @@ -670,7 +682,7 @@ export class TableAggregate<T extends AnyTableAggregateType> extends Aggregate<
): Promise<void> {
await this._insert(
ctx,
this.options.namespace(doc),
this.options.namespace?.(doc),
this.options.sortKey(doc),
doc._id as TableAggregateId<T>,
this.options.sumValue?.(doc)
Expand All @@ -682,7 +694,7 @@ export class TableAggregate<T extends AnyTableAggregateType> extends Aggregate<
): Promise<void> {
await this._delete(
ctx,
this.options.namespace(doc),
this.options.namespace?.(doc),
this.options.sortKey(doc),
doc._id as TableAggregateId<T>
);
Expand All @@ -694,9 +706,9 @@ export class TableAggregate<T extends AnyTableAggregateType> extends Aggregate<
): Promise<void> {
await this._replace(
ctx,
this.options.namespace(oldDoc),
this.options.namespace?.(oldDoc),
this.options.sortKey(oldDoc),
this.options.namespace(newDoc),
this.options.namespace?.(newDoc),
this.options.sortKey(newDoc),
newDoc._id as TableAggregateId<T>,
this.options.sumValue?.(newDoc)
Expand All @@ -708,7 +720,7 @@ export class TableAggregate<T extends AnyTableAggregateType> extends Aggregate<
): Promise<void> {
await this._insertIfDoesNotExist(
ctx,
this.options.namespace(doc),
this.options.namespace?.(doc),
this.options.sortKey(doc),
doc._id as TableAggregateId<T>,
this.options.sumValue?.(doc)
Expand All @@ -720,7 +732,7 @@ export class TableAggregate<T extends AnyTableAggregateType> extends Aggregate<
): Promise<void> {
await this._deleteIfExists(
ctx,
this.options.namespace(doc),
this.options.namespace?.(doc),
this.options.sortKey(doc),
doc._id as TableAggregateId<T>
);
Expand All @@ -732,9 +744,9 @@ export class TableAggregate<T extends AnyTableAggregateType> extends Aggregate<
): Promise<void> {
await this._replaceOrInsert(
ctx,
this.options.namespace(oldDoc),
this.options.namespace?.(oldDoc),
this.options.sortKey(oldDoc),
this.options.namespace(newDoc),
this.options.namespace?.(newDoc),
this.options.sortKey(newDoc),
newDoc._id as TableAggregateId<T>,
this.options.sumValue?.(newDoc)
Expand All @@ -759,7 +771,7 @@ export class TableAggregate<T extends AnyTableAggregateType> extends Aggregate<
): Promise<number> {
const key = this.options.sortKey(doc);
return this.indexOf(ctx, key, {
namespace: this.options.namespace(doc),
namespace: this.options.namespace?.(doc),
...opts,
});
}
Expand Down Expand Up @@ -841,7 +853,7 @@ export type NamespacedArgs<Args, Namespace> =
| (Namespace extends undefined ? Args : never);
export type NamespacedOpts<Opts, Namespace> =
| [{ namespace: Namespace } & Opts]
| (Namespace extends undefined ? [Opts?] : never);
| (undefined extends Namespace ? [Opts?] : never);

function namespaceFromArg<Args extends object, Namespace>(
args: NamespacedArgs<Args, Namespace>
Expand Down