Files
dm-companion/src/lib/types.ts
2025-05-31 18:11:26 -07:00

111 lines
2.2 KiB
TypeScript

import type { RecordModel } from "pocketbase";
export type Id<T extends string> = string & { __type: T };
export type UserId = Id<"User">;
export type CampaignId = Id<"Campaign">;
export type DocumentId = Id<"Document">;
export type ISO8601Date = string & { __type: "iso8601date" };
export type Campaign = RecordModel & {
id: CampaignId;
name: string;
owner: UserId;
};
/******************************************
* Relationships
******************************************/
export const RelationshipType = {
DiscoveredIn: "discoveredIn",
Scenes: "scenes",
Secrets: "secrets",
Treasures: "treasures",
} as const;
export type RelationshipType =
(typeof RelationshipType)[keyof typeof RelationshipType];
export type Relationship = RecordModel & {
primary: DocumentId;
secondary: DocumentId[];
type: RelationshipType;
};
/******************************************
* Documents
******************************************/
export type DocumentData<K extends string, V> = {
data: Record<K, V>;
};
export type Document = RecordModel & {
id: DocumentId;
campaign: CampaignId;
data: {};
// These two are not in Pocketbase's types, but they seem to always be present
created: ISO8601Date;
updated: ISO8601Date;
};
/** Session **/
export type Session = Document &
DocumentData<
"session",
{
strongStart: string;
}
>;
export function isSession(doc: Document): doc is Session {
return Object.hasOwn(doc.data, "session");
}
/** Scene **/
export type Scene = Document &
DocumentData<
"scene",
{
text: string;
}
>;
export function isScene(doc: Document): doc is Scene {
return Object.hasOwn(doc.data, "scene");
}
/** Secret **/
export type Secret = Document &
DocumentData<
"secret",
{
text: string;
discovered: boolean;
}
>;
export function isSecret(doc: Document): doc is Secret {
return Object.hasOwn(doc.data, "secret");
}
/** Treasure **/
export type Treasure = Document &
DocumentData<
"treasure",
{
text: string;
discovered: boolean;
}
>;
export function isTreasure(doc: Document): doc is Treasure {
return Object.hasOwn(doc.data, "treasure");
}