lazypock 0.1.0 → 0.1.2

package/src/types.ts

@@ -1,15 +1,49 @@
 // ── Record & Collection types ───────────────────────────
 
-/** Shape of a record returned from any collection. */
-export interface ApiRecord {
+/**
+ * Base shape every record returned from any collection satisfies.
+ * Generated record interfaces extend this.
+ */
+export interface BaseRecordFields {
 	id: string;
 	collectionId: string;
 	collectionName: string;
 	created: string;
 	updated: string;
+}
+
+/** Shape of a record returned from any collection. */
+export interface ApiRecord extends BaseRecordFields {
 	[key: string]: unknown;
 }
 
+/**
+ * Structural marker for concrete record shapes (generated or hand-written).
+ * Used to differentiate a typed collection service from the untyped default.
+ */
+export type RecordShape = Record<string, unknown>;
+
+/** System fields every record carries — not user-provided on create. */
+export type SystemFields =
+	| "id"
+	| "collectionId"
+	| "collectionName"
+	| "created"
+	| "updated";
+
+/**
+ * Data accepted by `create()`: any subset of `T`'s fields, but
+ * never the system fields. Unknown/extra keys are rejected at compile
+ * time via excess-property checking (object literals).
+ */
+export type CreateData<T> = Partial<Omit<T, SystemFields>>;
+
+/**
+ * Data accepted by `update()`: any subset of `T`'s fields.
+ * Unknown/extra keys are rejected at compile time.
+ */
+export type UpdateData<T> = Partial<Omit<T, SystemFields>>;
+
 /** Paginated list response matching PocketBase format. */
 export interface ListResult<T = ApiRecord> {
 	items: T[];