bleam 0.0.6 → 0.0.8

package/dist/state.d.cts

@@ -1,4 +1,4 @@
-import { f as SchemaOutput, l as SchemaInput, m as SchemaShape, t as BleamSchema } from "./schema-BOuUHcqo.cjs";
+import { a as FieldValue, f as SchemaOutput, l as SchemaInput, m as SchemaShape, t as BleamSchema } from "./schema-ENSMX_1t.cjs";
 
 //#region src/state/atom.d.ts
 type Listener = () => void;
@@ -20,110 +20,140 @@ declare class LiveStore<Value> implements WritableStore<Value> {
   subscribe(listener: Listener): () => void;
 }
 type Atom<Value> = WritableStore<Value>;
+type SetStoreValue<Value> = (value: Value | ((current: Value) => Value)) => void;
 declare function atom<Value>(initialValue: Value): Atom<Value>;
 declare function useStore<Value>(store: Store<Value>): Value;
-declare function useAtom<Value>(value: Atom<Value>): Value;
+declare function useAtom<Value>(value: Atom<Value>): readonly [Value, SetStoreValue<Value>];
 //#endregion
 //#region src/state/collection.d.ts
+type FieldRecord = Record<string, FieldValue | undefined>;
 type CollectionFields<Shape extends SchemaShape> = SchemaOutput<Shape>;
 type CollectionInput<Shape extends SchemaShape> = SchemaInput<Shape>;
-type CollectionData<Shape extends SchemaShape> = CollectionFields<Shape> | undefined;
-type CollectionRecord<Shape extends SchemaShape> = CollectionFields<Shape> & {
-  readonly id: string;
-  data(): CollectionData<Shape>;
-  delete(): Promise<void>;
-  readonly set: (patch: Partial<CollectionInput<Shape>>) => Promise<void>;
-  with(name: string): unknown | undefined;
-  with<OtherShape extends SchemaShape>(collection: Collection<OtherShape>): CollectionRecord<OtherShape>[];
+type CollectionData<Shape extends SchemaShape> = CollectionFields<Shape>;
+type CollectionFieldKey<Shape extends SchemaShape> = Extract<keyof Shape, string>;
+type CollectionFieldValue<Shape extends SchemaShape, Key extends CollectionFieldKey<Shape>> = Key extends keyof CollectionData<Shape> ? CollectionData<Shape>[Key] : undefined;
+type Entry<Value> = {
+  value: Value | undefined;
+  error: unknown;
+  promise: Promise<unknown> | null;
+  version: number;
+  listeners: Set<Listener>;
+};
+type RawCollectionView = {
+  id: string;
+  collection: string;
+  createdAt: string;
+  updatedAt: string;
+  data: FieldRecord;
+  links: Record<string, string[]>;
+};
+type RecordEntry = Entry<RawCollectionView | null>;
+type ListEntry = Entry<string[]> & {
+  dependencies: ListDependencies;
 };
 type CollectionReference = {
   readonly name: string;
   get(id: string): Promise<unknown>;
-  refreshQueries(): Promise<void>;
-  pin(record: object | string, name: string, target: object | CollectionReference, targetId?: string): Promise<void>;
-  unpin(record: object | string, name: string): Promise<void>;
 };
-type AnyRecord = object;
-type JoinFilter = {
-  kind: 'record';
-  record: AnyRecord;
-} | {
-  kind: 'id';
-  collection: CollectionReference;
+type ViewOptions = {
+  links?: CollectionReference[];
+};
+type ListWhereValue = FieldValue | ['equals' | 'greater-than' | 'less-than' | 'contains', FieldValue] | Array<['equals' | 'greater-than' | 'less-than' | 'contains', FieldValue]>;
+type ListOptions<Shape extends SchemaShape> = {
+  where?: Partial<Record<CollectionFieldKey<Shape>, ListWhereValue>>;
+  sortBy?: CollectionFieldKey<Shape> | 'createdAt' | 'updatedAt';
+  order?: 'asc' | 'desc';
+  take?: number;
+};
+type NormalizedListOptions = {
+  where?: Record<string, Array<[string, FieldValue]>>;
+  sortBy?: string;
+  order?: 'asc' | 'desc';
+  take?: number;
+};
+type RecordChange = {
+  collection: string;
   id: string;
+  previous: RawCollectionView | null;
+  next: RawCollectionView | null;
+  changedPaths: Set<string>;
+};
+type EdgeChange = {
+  type: 'link' | 'unlink';
+  left: {
+    collection: string;
+    id: string;
+  };
+  right: {
+    collection: string;
+    id: string;
+  };
 };
-type JoinInclude = {
-  collection: CollectionReference;
+type ListDependencies = {
+  collection: string;
+  paths: Set<string>;
+  options: NormalizedListOptions;
 };
-type PinInclude = {
-  name: string;
-  target: CollectionReference;
+type CollectionView<Shape extends SchemaShape> = {
+  readonly id: string;
+  readonly collection: string;
+  readonly createdAt: string;
+  readonly updatedAt: string;
+  readonly data: CollectionData<Shape>;
+  readonly links: Record<string, string[]>;
 };
 declare class Collection<Shape extends SchemaShape> {
   readonly name: string;
   readonly shape: Shape;
   readonly validator: BleamSchema<SchemaInput<Shape>, SchemaOutput<Shape>>;
-  private queries;
-  private store;
+  private records;
+  private lists;
+  private fields;
   constructor(name: string, shape: Shape);
-  private initialize;
-  private load;
-  private notifyRecordListeners;
-  private currentRecords;
-  refreshQueries(): Promise<void>;
-  insert(value: CollectionInput<Shape>): Promise<CollectionRecord<Shape>>;
-  update(record: CollectionFields<Shape> | string, value: Partial<CollectionInput<Shape>>): Promise<void>;
-  delete(record: CollectionFields<Shape> | string): Promise<void>;
-  all(): Promise<CollectionRecord<Shape>[]>;
-  get(id: string): Promise<CollectionRecord<Shape> | undefined>;
-  pin(record: CollectionFields<Shape> | string, name: string, target: object | CollectionReference, targetId?: string): Promise<void>;
-  unpin(record: CollectionFields<Shape> | string, name: string): Promise<void>;
-  subscribeRecord(record: CollectionFields<Shape>, listener: Listener): () => void;
-  queryStore(query?: {
-    joins: JoinFilter[];
-    joinIncludes: JoinInclude[];
-    pinIncludes: PinInclude[];
-  }): Store<CollectionRecord<Shape>[]>;
-  private executeQuery;
+  validateListOptions(options?: ListOptions<Shape>): void;
+  getRecordEntry(id: string): RecordEntry;
+  getListEntry(options?: ListOptions<Shape>): ListEntry;
+  private getFieldEntry;
+  private notifyFields;
+  private setRecordValue;
+  private rawRecord;
+  private loadRecord;
+  private loadListRows;
+  private selectListRows;
+  private applyListOptions;
+  private refreshListEntry;
+  invalidateChanges(recordChanges: RecordChange[], edgeChanges?: EdgeChange[]): Promise<void>;
+  private refreshLoadedLinks;
+  private peekRecord;
+  insert(value: CollectionInput<Shape>): Promise<string>;
+  update(id: string, value: Partial<CollectionInput<Shape>>): Promise<void>;
+  delete(id: string): Promise<void>;
+  all(): Promise<CollectionView<Shape>[]>;
+  get(id: string): Promise<CollectionView<Shape> | null>;
+  subscribeRecord(id: string, listener: Listener): () => void;
+  subscribeList(options: ListOptions<Shape> | undefined, listener: Listener): () => void;
+  subscribeField(id: string, path: string, listener: Listener): () => void;
+  getRecordVersion(id: string): number;
+  getListVersion(options?: ListOptions<Shape>): number;
+  getFieldVersion(id: string, path: string): number;
+  getRecordSnapshot(id: string, options?: ViewOptions): CollectionView<Shape> | null | undefined;
+  getListSnapshot(options?: ListOptions<Shape>): string[] | undefined;
+  ensureRecord(id: string, options?: ViewOptions): Promise<RawCollectionView | null>;
+  ensureList(options?: ListOptions<Shape>): Promise<string[]>;
   private deleteLinksForRecord;
-  private deletePinsForRecord;
 }
 declare function collection<Shape extends SchemaShape>(name: string, shape: Shape): Collection<Shape>;
-declare function link(first: object, second: object): Promise<void>;
 declare function link<FirstShape extends SchemaShape, SecondShape extends SchemaShape>(firstCollection: Collection<FirstShape>, firstId: string, secondCollection: Collection<SecondShape>, secondId: string): Promise<void>;
-declare function unlink(first: object, second: object): Promise<void>;
 declare function unlink<FirstShape extends SchemaShape, SecondShape extends SchemaShape>(firstCollection: Collection<FirstShape>, firstId: string, secondCollection: Collection<SecondShape>, secondId: string): Promise<void>;
-declare function isLinked(first: object, second: object): Promise<boolean>;
 declare function isLinked<FirstShape extends SchemaShape, SecondShape extends SchemaShape>(firstCollection: Collection<FirstShape>, firstId: string, secondCollection: Collection<SecondShape>, secondId: string): Promise<boolean>;
-declare function pin(source: object, name: string, target: object): Promise<void>;
-declare function pin<SourceShape extends SchemaShape, TargetShape extends SchemaShape>(sourceCollection: Collection<SourceShape>, sourceId: string, name: string, targetCollection: Collection<TargetShape>, targetId: string): Promise<void>;
-declare function unpin(source: object, name: string): Promise<void>;
-declare function unpin<SourceShape extends SchemaShape>(sourceCollection: Collection<SourceShape>, sourceId: string, name: string): Promise<void>;
-declare function isPinned(source: object, name: string, target: object): Promise<boolean>;
-declare function isPinned<SourceShape extends SchemaShape, TargetShape extends SchemaShape>(sourceCollection: Collection<SourceShape>, sourceId: string, name: string, targetCollection: Collection<TargetShape>, targetId: string): Promise<boolean>;
-declare class CollectionQuery<Shape extends SchemaShape> implements Store<CollectionRecord<Shape>[]> {
-  private readonly collection;
-  private joins;
-  private joinIncludes;
-  private pinIncludes;
-  private cachedStore?;
-  constructor(collection: Collection<Shape>);
-  join(record: object): this;
-  join<OtherShape extends SchemaShape>(collection: Collection<OtherShape>): this;
-  join<OtherShape extends SchemaShape>(collection: Collection<OtherShape>, id: string): this;
-  with<OtherShape extends SchemaShape>(name: string, target: Collection<OtherShape>): this;
-  get(): CollectionRecord<Shape>[];
-  subscribe(listener: Listener): () => void;
-  store(): Store<CollectionRecord<Shape>[]>;
-}
-declare class QueryBuilder {
-  from<Shape extends SchemaShape>(collection: Collection<Shape>): CollectionQuery<Shape>;
-}
-declare function useQuery<Output>(query: (builder: QueryBuilder) => Store<Output>): Output;
+declare function useList<Shape extends SchemaShape>(collection: Collection<Shape>, options?: ListOptions<Shape>): string[];
+declare function useView<Shape extends SchemaShape>(collection: Collection<Shape>, id: string, options?: ViewOptions): CollectionView<Shape> | null | undefined;
+declare function useField<Shape extends SchemaShape, Key extends CollectionFieldKey<Shape>>(collection: Collection<Shape>, id: string, key: Key): CollectionFieldValue<Shape, Key> | undefined;
 //#endregion
 //#region src/state/setting.d.ts
 type Setting<Value> = WritableStore<Value>;
+type SetSettingValue<Value> = SetStoreValue<Value>;
 declare function setting<Value extends string | number | boolean>(key: string, initialValue: Value): Setting<Value>;
-declare function useSetting<Value>(value: Setting<Value>): Value;
+declare function useSetting<Value>(value: Setting<Value>): readonly [Value, SetStoreValue<Value>];
 //#endregion
-export { Atom, Collection, CollectionRecord, Listener, LiveStore, QueryBuilder, Setting, Store, WritableStore, atom, collection, isLinked, isPinned, link, pin, setting, unlink, unpin, useAtom, useQuery, useSetting, useStore };
+export { Atom, Collection, CollectionView, ListOptions, Listener, LiveStore, SetSettingValue, SetStoreValue, Setting, Store, WritableStore, atom, collection, isLinked, link, setting, unlink, useAtom, useField, useList, useSetting, useStore, useView };

package/dist/state.d.ts

@@ -1,4 +1,4 @@
-import { f as SchemaOutput, l as SchemaInput, m as SchemaShape, t as BleamSchema } from "./schema-ipsECAso.js";
+import { a as FieldValue, f as SchemaOutput, l as SchemaInput, m as SchemaShape, t as BleamSchema } from "./schema-DOOjfXvs.js";
 
 //#region src/state/atom.d.ts
 type Listener = () => void;
@@ -20,110 +20,140 @@ declare class LiveStore<Value> implements WritableStore<Value> {
   subscribe(listener: Listener): () => void;
 }
 type Atom<Value> = WritableStore<Value>;
+type SetStoreValue<Value> = (value: Value | ((current: Value) => Value)) => void;
 declare function atom<Value>(initialValue: Value): Atom<Value>;
 declare function useStore<Value>(store: Store<Value>): Value;
-declare function useAtom<Value>(value: Atom<Value>): Value;
+declare function useAtom<Value>(value: Atom<Value>): readonly [Value, SetStoreValue<Value>];
 //#endregion
 //#region src/state/collection.d.ts
+type FieldRecord = Record<string, FieldValue | undefined>;
 type CollectionFields<Shape extends SchemaShape> = SchemaOutput<Shape>;
 type CollectionInput<Shape extends SchemaShape> = SchemaInput<Shape>;
-type CollectionData<Shape extends SchemaShape> = CollectionFields<Shape> | undefined;
-type CollectionRecord<Shape extends SchemaShape> = CollectionFields<Shape> & {
-  readonly id: string;
-  data(): CollectionData<Shape>;
-  delete(): Promise<void>;
-  readonly set: (patch: Partial<CollectionInput<Shape>>) => Promise<void>;
-  with(name: string): unknown | undefined;
-  with<OtherShape extends SchemaShape>(collection: Collection<OtherShape>): CollectionRecord<OtherShape>[];
+type CollectionData<Shape extends SchemaShape> = CollectionFields<Shape>;
+type CollectionFieldKey<Shape extends SchemaShape> = Extract<keyof Shape, string>;
+type CollectionFieldValue<Shape extends SchemaShape, Key extends CollectionFieldKey<Shape>> = Key extends keyof CollectionData<Shape> ? CollectionData<Shape>[Key] : undefined;
+type Entry<Value> = {
+  value: Value | undefined;
+  error: unknown;
+  promise: Promise<unknown> | null;
+  version: number;
+  listeners: Set<Listener>;
+};
+type RawCollectionView = {
+  id: string;
+  collection: string;
+  createdAt: string;
+  updatedAt: string;
+  data: FieldRecord;
+  links: Record<string, string[]>;
+};
+type RecordEntry = Entry<RawCollectionView | null>;
+type ListEntry = Entry<string[]> & {
+  dependencies: ListDependencies;
 };
 type CollectionReference = {
   readonly name: string;
   get(id: string): Promise<unknown>;
-  refreshQueries(): Promise<void>;
-  pin(record: object | string, name: string, target: object | CollectionReference, targetId?: string): Promise<void>;
-  unpin(record: object | string, name: string): Promise<void>;
 };
-type AnyRecord = object;
-type JoinFilter = {
-  kind: 'record';
-  record: AnyRecord;
-} | {
-  kind: 'id';
-  collection: CollectionReference;
+type ViewOptions = {
+  links?: CollectionReference[];
+};
+type ListWhereValue = FieldValue | ['equals' | 'greater-than' | 'less-than' | 'contains', FieldValue] | Array<['equals' | 'greater-than' | 'less-than' | 'contains', FieldValue]>;
+type ListOptions<Shape extends SchemaShape> = {
+  where?: Partial<Record<CollectionFieldKey<Shape>, ListWhereValue>>;
+  sortBy?: CollectionFieldKey<Shape> | 'createdAt' | 'updatedAt';
+  order?: 'asc' | 'desc';
+  take?: number;
+};
+type NormalizedListOptions = {
+  where?: Record<string, Array<[string, FieldValue]>>;
+  sortBy?: string;
+  order?: 'asc' | 'desc';
+  take?: number;
+};
+type RecordChange = {
+  collection: string;
   id: string;
+  previous: RawCollectionView | null;
+  next: RawCollectionView | null;
+  changedPaths: Set<string>;
+};
+type EdgeChange = {
+  type: 'link' | 'unlink';
+  left: {
+    collection: string;
+    id: string;
+  };
+  right: {
+    collection: string;
+    id: string;
+  };
 };
-type JoinInclude = {
-  collection: CollectionReference;
+type ListDependencies = {
+  collection: string;
+  paths: Set<string>;
+  options: NormalizedListOptions;
 };
-type PinInclude = {
-  name: string;
-  target: CollectionReference;
+type CollectionView<Shape extends SchemaShape> = {
+  readonly id: string;
+  readonly collection: string;
+  readonly createdAt: string;
+  readonly updatedAt: string;
+  readonly data: CollectionData<Shape>;
+  readonly links: Record<string, string[]>;
 };
 declare class Collection<Shape extends SchemaShape> {
   readonly name: string;
   readonly shape: Shape;
   readonly validator: BleamSchema<SchemaInput<Shape>, SchemaOutput<Shape>>;
-  private queries;
-  private store;
+  private records;
+  private lists;
+  private fields;
   constructor(name: string, shape: Shape);
-  private initialize;
-  private load;
-  private notifyRecordListeners;
-  private currentRecords;
-  refreshQueries(): Promise<void>;
-  insert(value: CollectionInput<Shape>): Promise<CollectionRecord<Shape>>;
-  update(record: CollectionFields<Shape> | string, value: Partial<CollectionInput<Shape>>): Promise<void>;
-  delete(record: CollectionFields<Shape> | string): Promise<void>;
-  all(): Promise<CollectionRecord<Shape>[]>;
-  get(id: string): Promise<CollectionRecord<Shape> | undefined>;
-  pin(record: CollectionFields<Shape> | string, name: string, target: object | CollectionReference, targetId?: string): Promise<void>;
-  unpin(record: CollectionFields<Shape> | string, name: string): Promise<void>;
-  subscribeRecord(record: CollectionFields<Shape>, listener: Listener): () => void;
-  queryStore(query?: {
-    joins: JoinFilter[];
-    joinIncludes: JoinInclude[];
-    pinIncludes: PinInclude[];
-  }): Store<CollectionRecord<Shape>[]>;
-  private executeQuery;
+  validateListOptions(options?: ListOptions<Shape>): void;
+  getRecordEntry(id: string): RecordEntry;
+  getListEntry(options?: ListOptions<Shape>): ListEntry;
+  private getFieldEntry;
+  private notifyFields;
+  private setRecordValue;
+  private rawRecord;
+  private loadRecord;
+  private loadListRows;
+  private selectListRows;
+  private applyListOptions;
+  private refreshListEntry;
+  invalidateChanges(recordChanges: RecordChange[], edgeChanges?: EdgeChange[]): Promise<void>;
+  private refreshLoadedLinks;
+  private peekRecord;
+  insert(value: CollectionInput<Shape>): Promise<string>;
+  update(id: string, value: Partial<CollectionInput<Shape>>): Promise<void>;
+  delete(id: string): Promise<void>;
+  all(): Promise<CollectionView<Shape>[]>;
+  get(id: string): Promise<CollectionView<Shape> | null>;
+  subscribeRecord(id: string, listener: Listener): () => void;
+  subscribeList(options: ListOptions<Shape> | undefined, listener: Listener): () => void;
+  subscribeField(id: string, path: string, listener: Listener): () => void;
+  getRecordVersion(id: string): number;
+  getListVersion(options?: ListOptions<Shape>): number;
+  getFieldVersion(id: string, path: string): number;
+  getRecordSnapshot(id: string, options?: ViewOptions): CollectionView<Shape> | null | undefined;
+  getListSnapshot(options?: ListOptions<Shape>): string[] | undefined;
+  ensureRecord(id: string, options?: ViewOptions): Promise<RawCollectionView | null>;
+  ensureList(options?: ListOptions<Shape>): Promise<string[]>;
   private deleteLinksForRecord;
-  private deletePinsForRecord;
 }
 declare function collection<Shape extends SchemaShape>(name: string, shape: Shape): Collection<Shape>;
-declare function link(first: object, second: object): Promise<void>;
 declare function link<FirstShape extends SchemaShape, SecondShape extends SchemaShape>(firstCollection: Collection<FirstShape>, firstId: string, secondCollection: Collection<SecondShape>, secondId: string): Promise<void>;
-declare function unlink(first: object, second: object): Promise<void>;
 declare function unlink<FirstShape extends SchemaShape, SecondShape extends SchemaShape>(firstCollection: Collection<FirstShape>, firstId: string, secondCollection: Collection<SecondShape>, secondId: string): Promise<void>;
-declare function isLinked(first: object, second: object): Promise<boolean>;
 declare function isLinked<FirstShape extends SchemaShape, SecondShape extends SchemaShape>(firstCollection: Collection<FirstShape>, firstId: string, secondCollection: Collection<SecondShape>, secondId: string): Promise<boolean>;
-declare function pin(source: object, name: string, target: object): Promise<void>;
-declare function pin<SourceShape extends SchemaShape, TargetShape extends SchemaShape>(sourceCollection: Collection<SourceShape>, sourceId: string, name: string, targetCollection: Collection<TargetShape>, targetId: string): Promise<void>;
-declare function unpin(source: object, name: string): Promise<void>;
-declare function unpin<SourceShape extends SchemaShape>(sourceCollection: Collection<SourceShape>, sourceId: string, name: string): Promise<void>;
-declare function isPinned(source: object, name: string, target: object): Promise<boolean>;
-declare function isPinned<SourceShape extends SchemaShape, TargetShape extends SchemaShape>(sourceCollection: Collection<SourceShape>, sourceId: string, name: string, targetCollection: Collection<TargetShape>, targetId: string): Promise<boolean>;
-declare class CollectionQuery<Shape extends SchemaShape> implements Store<CollectionRecord<Shape>[]> {
-  private readonly collection;
-  private joins;
-  private joinIncludes;
-  private pinIncludes;
-  private cachedStore?;
-  constructor(collection: Collection<Shape>);
-  join(record: object): this;
-  join<OtherShape extends SchemaShape>(collection: Collection<OtherShape>): this;
-  join<OtherShape extends SchemaShape>(collection: Collection<OtherShape>, id: string): this;
-  with<OtherShape extends SchemaShape>(name: string, target: Collection<OtherShape>): this;
-  get(): CollectionRecord<Shape>[];
-  subscribe(listener: Listener): () => void;
-  store(): Store<CollectionRecord<Shape>[]>;
-}
-declare class QueryBuilder {
-  from<Shape extends SchemaShape>(collection: Collection<Shape>): CollectionQuery<Shape>;
-}
-declare function useQuery<Output>(query: (builder: QueryBuilder) => Store<Output>): Output;
+declare function useList<Shape extends SchemaShape>(collection: Collection<Shape>, options?: ListOptions<Shape>): string[];
+declare function useView<Shape extends SchemaShape>(collection: Collection<Shape>, id: string, options?: ViewOptions): CollectionView<Shape> | null | undefined;
+declare function useField<Shape extends SchemaShape, Key extends CollectionFieldKey<Shape>>(collection: Collection<Shape>, id: string, key: Key): CollectionFieldValue<Shape, Key> | undefined;
 //#endregion
 //#region src/state/setting.d.ts
 type Setting<Value> = WritableStore<Value>;
+type SetSettingValue<Value> = SetStoreValue<Value>;
 declare function setting<Value extends string | number | boolean>(key: string, initialValue: Value): Setting<Value>;
-declare function useSetting<Value>(value: Setting<Value>): Value;
+declare function useSetting<Value>(value: Setting<Value>): readonly [Value, SetStoreValue<Value>];
 //#endregion
-export { Atom, Collection, CollectionRecord, Listener, LiveStore, QueryBuilder, Setting, Store, WritableStore, atom, collection, isLinked, isPinned, link, pin, setting, unlink, unpin, useAtom, useQuery, useSetting, useStore };
+export { Atom, Collection, CollectionView, ListOptions, Listener, LiveStore, SetSettingValue, SetStoreValue, Setting, Store, WritableStore, atom, collection, isLinked, link, setting, unlink, useAtom, useField, useList, useSetting, useStore, useView };