@fireproof/database - npm Package Compare versions

Comparing version 0.10.14 to 0.10.15

dist/types/index.d.ts

@@ -12,2 +12,157 @@ export * from './crdt-helpers';
 export * from './store';
-export * from './transaction';
+export * from './transaction';
+
+import { Link } from 'multiformats'
+import { EventLink } from '@alanshaw/pail/clock'
+import { EventData } from '@alanshaw/pail/crdt'
+
+export type ClockHead = EventLink<EventData>[]
+
+type DocBody = {
+  [key: string]: any
+}
+
+export type Doc = DocBody & {
+  _id: string
+}
+
+export type DocUpdate = {
+  key: string
+  value?: DocBody
+  del?: boolean
+}
+
+export type DocValue = {
+  doc?: DocBody
+  del?: boolean
+}
+
+type IndexCars = {
+  [key: string]: AnyLink
+}
+
+export type IndexKey = [string, string] | string
+
+export type IndexUpdate = {
+  key: IndexKey
+  value?: DocFragment
+  del?: boolean
+}
+
+export type IndexRow = {
+  id: string
+  key: IndexKey
+  doc?: Doc | null
+  value?: DocFragment
+  del?: boolean
+}
+
+export type CarCommit = {
+  car?: AnyLink
+}
+
+export type BulkResult = {
+  head: ClockHead
+}
+
+export type BulkResultCar = BulkResult & CarCommit
+
+type CarHeader = {
+  cars: AnyLink[]
+  compact: AnyLink[]
+}
+
+export type DbCarHeader = CarHeader & {
+  head: ClockHead
+}
+
+export type IdxMeta = {
+  byId: AnyLink
+  byKey: AnyLink
+  map: string
+  name: string
+  head: ClockHead
+}
+
+type IdxMetaMap = {
+  indexes: Map<string, IdxMeta>
+}
+
+export type IdxMetaCar = IdxMeta & CarCommit
+
+export type IdxCarHeader = CarHeader & IdxMetaMap
+
+export type IndexerResult = CarCommit & IdxMetaMap
+
+export type QueryOpts = {
+  descending?: boolean
+  limit?: number
+  includeDocs?: boolean
+  range?: [IndexKey, IndexKey]
+  key?: string // these two can be richer than keys...
+  prefix?: string | [string]
+}
+
+export type AnyLink = Link<unknown, number, number, 1 | 0>
+export type AnyBlock = { cid: AnyLink; bytes: Uint8Array }
+export type BlockFetcher = { get: (link: AnyLink) => Promise<AnyBlock | undefined> }
+
+export type DbResponse = {
+  id: string
+  clock: ClockHead
+}
+
+export type ChangesResponse = {
+  clock: ClockHead
+  rows: { key: string; value: Doc }[]
+}
+
+// ProllyNode type based on the ProllyNode from 'prolly-trees/base'
+export interface ProllyNode extends BaseNode {
+  getAllEntries(): PromiseLike<{ [x: string]: any; result: IndexRow[] }>
+  getMany(removeIds: string[]): Promise<{ [x: string]: any; result: IndexKey[] }>
+  range(a: IndexKey, b: IndexKey): Promise<{ result: IndexRow[] }>
+  get(key: string): Promise<{ result: IndexRow[] }>
+  bulk(bulk: IndexUpdate[]): PromiseLike<{ root: ProllyNode | null; blocks: Block[] }>
+  address: Promise<Link>
+  distance: number
+  compare: (a: any, b: any) => number
+  cache: any
+  block: Promise<Block>
+}
+// export interface CIDCounter {
+//   add(node: ProllyNode): void
+//   all(): Promise<Set<string | Promise<string>>>
+// }
+
+export interface StaticProllyOptions {
+  cache: any
+  chunker: (entry: any, distance: number) => boolean
+  codec: any
+  hasher: any
+  compare: (a: any, b: any) => number
+}
+
+export type ProllyOptions = StaticProllyOptions & {
+  cid?: Link
+  list?: DocUpdate[]
+  get: (cid: any) => Promise<any>
+}
+
+export type DocFragment = string | number | boolean | null | DocFragment[] | { [key: string]: DocFragment }
+
+type CallbackFn = (k: string, v: DocFragment) => void
+
+export type MapFn = (doc: Doc, map: CallbackFn) => DocFragment | void
+
+export type ListenerFn = (docs: Doc[]) => Promise<void> | void
+
+export interface HeaderStoreInterface {
+  name: string
+  makeHeader(car: AnyLink, indexes: IndexCars): ByteView<DbMeta>
+  parseHeader(headerData: Uint8Array): DbMeta
+  load(branch?: string): Promise<DbMeta | null>
+  save(carCid: AnyLink, indexes: IndexCars, branch?: string): Promise<void>
+}
+
+export type DbMeta = { car: AnyLink, indexes: IndexCars}

package.json

 {
   "name": "@fireproof/database",
-  "version": "0.10.14",
+  "version": "0.10.15",
   "description": "Immutable embedded distributed database for the web",
@@ -5,0 +5,0 @@ "main": "dist/fireproof.cjs",

src/types.d.ts

 import { Link } from 'multiformats'
 import { EventLink } from '@alanshaw/pail/clock'
 import { EventData } from '@alanshaw/pail/crdt'
-import { AnyLink } from './types'
 
@@ -47,7 +46,2 @@ export type ClockHead = EventLink<EventData>[]
 
-// type IdxTree = {
-//   cid: AnyLink | null
-//   root: ProllyNode | null
-// }
-
 export type CarCommit = {
@@ -54,0 +48,0 @@ car?: AnyLink

No alert changes

Improved metrics

Total package byte prevSize

10875938

0.03%

Lines of code

115941

0.1%

No dependency changes