tabshift/jazz-tools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #10 from gardencmp/anselm/gar-103-simplify-meta-generics-and-content-type-types

Browse Source 
Simplify meta generics and content type types
This commit is contained in:
Anselm Eickhoff
2023-08-14 18:14:27 +01:00
committed by GitHub
parent 4e273b67a7 eb01fc5ae5
commit c352e9ac7e
7 changed files with 51 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/account.ts
View File

@@ -48,7 +48,7 @@ export interface GeneralizedControlledAccount {
export class ControlledAccount extends Account implements GeneralizedControlledAccount {
agentSecret: AgentSecret;
constructor(agentSecret: AgentSecret, teamMap: CoMap<TeamContent, {}>, node: LocalNode) {
constructor(agentSecret: AgentSecret, teamMap: CoMap<TeamContent, AccountMeta>, node: LocalNode) {
super(teamMap, node);
this.agentSecret = agentSecret;

26
src/contentType.ts
View File

@@ -1,24 +1,26 @@
import { JsonValue } from './jsonValue.js';
import { RawCoID } from './ids.js';
import { CoMap } from './contentTypes/coMap.js';
import { CoStream } from './contentTypes/coStream.js';
import { Static } from './contentTypes/static.js';
import { CoList } from './contentTypes/coList.js';
import { JsonObject, JsonValue } from "./jsonValue.js";
import { RawCoID } from "./ids.js";
import { CoMap } from "./contentTypes/coMap.js";
import { CoStream } from "./contentTypes/coStream.js";
import { Static } from "./contentTypes/static.js";
import { CoList } from "./contentTypes/coList.js";
export type CoID<T extends ContentType> = RawCoID & {
readonly __type: T;
};
export type ContentType =
| CoMap<{[key: string]: JsonValue}, JsonValue>
| CoList<JsonValue, JsonValue>
| CoStream<JsonValue, JsonValue>
| Static<JsonValue>;
| CoMap<{ [key: string]: JsonValue }, JsonObject | null>
| CoList<JsonValue, JsonObject | null>
| CoStream<JsonValue, JsonObject | null>
| Static<JsonObject>;
export function expectMap(content: ContentType): CoMap<{ [key: string]: string }, {}> {
export function expectMap(
content: ContentType
): CoMap<{ [key: string]: string }, JsonObject | null> {
if (content.type !== "comap") {
throw new Error("Expected map");
}
return content as CoMap<{ [key: string]: string }, {}>;
return content as CoMap<{ [key: string]: string }, JsonObject | null>;
}

2
src/contentTypes/coList.ts
View File

@@ -2,7 +2,7 @@ import { JsonObject, JsonValue } from '../jsonValue.js';
import { CoID } from '../contentType.js';
import { CoValue } from '../coValue.js';
export class CoList<T extends JsonValue, Meta extends JsonValue> {
export class CoList<T extends JsonValue, Meta extends JsonObject | null = null> {
id: CoID<CoList<T, Meta>>;
type = "colist" as const;
coValue: CoValue;

53
src/contentTypes/coMap.ts
View File

@@ -20,24 +20,25 @@ export type MapOpPayload<K extends string, V extends JsonValue> = {
key: K;
};
export type MapK<M extends { [key: string]: JsonValue; }> = keyof M & string;
export type MapV<M extends { [key: string]: JsonValue; }> = M[MapK<M>];
export type MapM<M extends { [key: string]: JsonValue; }> = {
[KK in MapK<M>]: M[KK];
}
export class CoMap<
M extends { [key: string]: JsonValue; },
Meta extends JsonValue,
K extends string = keyof M & string,
V extends JsonValue = M[K],
MM extends { [key: string]: JsonValue; } = {
[KK in K]: M[KK];
}
Meta extends JsonObject | null = null,
> {
id: CoID<CoMap<MM, Meta>>;
id: CoID<CoMap<MapM<M>, Meta>>;
coValue: CoValue;
type = "comap" as const;
ops: {
[KK in K]?: MapOp<K, M[KK]>[];
[KK in MapK<M>]?: MapOp<KK, M[KK]>[];
};
constructor(coValue: CoValue) {
this.id = coValue.id as CoID<CoMap<MM, Meta>>;
this.id = coValue.id as CoID<CoMap<MapM<M>, Meta>>;
this.coValue = coValue;
this.ops = {};
@@ -51,7 +52,7 @@ export class CoMap<
for (const [changeIdx, changeUntyped] of (
changes
).entries()) {
const change = changeUntyped as MapOpPayload<K, V>;
const change = changeUntyped as MapOpPayload<MapK<M>, MapV<M>>;
let entries = this.ops[change.key];
if (!entries) {
entries = [];
@@ -61,17 +62,17 @@ export class CoMap<
txID,
madeAt,
changeIdx,
...(change as MapOpPayload<K, M[K]>),
...(change as MapOpPayload<MapK<M>, MapV<M>>),
});
}
}
}
keys(): K[] {
return Object.keys(this.ops) as K[];
keys(): MapK<M>[] {
return Object.keys(this.ops) as MapK<M>[];
}
get<KK extends K>(key: KK): M[KK] | undefined {
get<K extends MapK<M>>(key: K): M[K] | undefined {
const ops = this.ops[key];
if (!ops) {
return undefined;
@@ -86,7 +87,7 @@ export class CoMap<
}
}
getAtTime<KK extends K>(key: KK, time: number): M[KK] | undefined {
getAtTime<K extends MapK<M>>(key: K, time: number): M[K] | undefined {
const ops = this.ops[key];
if (!ops) {
return undefined;
@@ -105,7 +106,7 @@ export class CoMap<
}
}
getLastTxID<KK extends K>(key: KK): TransactionID | undefined {
getLastTxID<K extends MapK<M>>(key: K): TransactionID | undefined {
const ops = this.ops[key];
if (!ops) {
return undefined;
@@ -116,7 +117,7 @@ export class CoMap<
return lastEntry.txID;
}
getLastEntry<KK extends K>(key: KK): { at: number; txID: TransactionID; value: M[KK]; } | undefined {
getLastEntry<K extends MapK<M>>(key: K): { at: number; txID: TransactionID; value: M[K]; } | undefined {
const ops = this.ops[key];
if (!ops) {
return undefined;
@@ -131,13 +132,13 @@ export class CoMap<
}
}
getHistory<KK extends K>(key: KK): { at: number; txID: TransactionID; value: M[KK] | undefined; }[] {
getHistory<K extends MapK<M>>(key: K): { at: number; txID: TransactionID; value: M[K] | undefined; }[] {
const ops = this.ops[key];
if (!ops) {
return [];
}
const history: { at: number; txID: TransactionID; value: M[KK] | undefined; }[] = [];
const history: { at: number; txID: TransactionID; value: M[K] | undefined; }[] = [];
for (const op of ops) {
if (op.op === "delete") {
@@ -178,14 +179,10 @@ export class CoMap<
export class WriteableCoMap<
M extends { [key: string]: JsonValue; },
Meta extends JsonValue,
K extends string = keyof M & string,
V extends JsonValue = M[K],
MM extends { [key: string]: JsonValue; } = {
[KK in K]: M[KK];
}
> extends CoMap<M, Meta, K, V, MM> {
set<KK extends K>(key: KK, value: M[KK], privacy: "private" | "trusting" = "private"): void {
Meta extends JsonObject | null = null,
> extends CoMap<M, Meta> {
set<K extends MapK<M>>(key: K, value: M[K], privacy: "private" | "trusting" = "private"): void {
this.coValue.makeTransaction([
{
op: "insert",
@@ -197,7 +194,7 @@ export class WriteableCoMap<
this.fillOpsFromCoValue();
}
delete(key: K, privacy: "private" | "trusting" = "private"): void {
delete(key: MapK<M>, privacy: "private" | "trusting" = "private"): void {
this.coValue.makeTransaction([
{
op: "delete",

2
src/contentTypes/coStream.ts
View File

@@ -2,7 +2,7 @@ import { JsonObject, JsonValue } from '../jsonValue.js';
import { CoID } from '../contentType.js';
import { CoValue } from '../coValue.js';
export class CoStream<T extends JsonValue, Meta extends JsonValue> {
export class CoStream<T extends JsonValue, Meta extends JsonObject | null = null> {
id: CoID<CoStream<T, Meta>>;
type = "costream" as const;
coValue: CoValue;

4
src/contentTypes/static.ts
View File

@@ -1,8 +1,8 @@
import { JsonObject, JsonValue } from '../jsonValue.js';
import { JsonObject } from '../jsonValue.js';
import { CoID } from '../contentType.js';
import { CoValue } from '../coValue.js';
export class Static<T extends JsonValue> {
export class Static<T extends JsonObject> {
id: CoID<Static<T>>;
type = "static" as const;
coValue: CoValue;

14
src/permissions.ts
View File

@@ -1,6 +1,6 @@
import { CoID, ContentType } from "./contentType.js";
import { CoMap, MapOpPayload } from "./contentTypes/coMap.js";
import { JsonValue } from "./jsonValue.js";
import { JsonObject, JsonValue } from "./jsonValue.js";
import {
Encrypted,
KeyID,
@@ -216,24 +216,24 @@ export type TeamContent = {
export function expectTeamContent(
content: ContentType
): CoMap<TeamContent, {}> {
): CoMap<TeamContent, JsonObject | null> {
if (content.type !== "comap") {
throw new Error("Expected map");
}
return content as CoMap<TeamContent, {}>;
return content as CoMap<TeamContent, JsonObject | null>;
}
export class Team {
teamMap: CoMap<TeamContent, {}>;
teamMap: CoMap<TeamContent, JsonObject | null>;
node: LocalNode;
constructor(teamMap: CoMap<TeamContent, {}>, node: LocalNode) {
constructor(teamMap: CoMap<TeamContent, JsonObject | null>, node: LocalNode) {
this.teamMap = teamMap;
this.node = node;
}
get id(): CoID<CoMap<TeamContent, {}>> {
get id(): CoID<CoMap<TeamContent, JsonObject | null>> {
return this.teamMap.id;
}
@@ -342,7 +342,7 @@ export class Team {
this.rotateReadKey();
}
createMap<M extends { [key: string]: JsonValue }, Meta extends JsonValue>(
createMap<M extends { [key: string]: JsonValue }, Meta extends JsonObject | null>(
meta?: M
): CoMap<M, Meta> {
return this.node