@based/db 0.0.27 → 0.0.29

package/README.md

@@ -18,7 +18,7 @@ BasedDb is a powerful database solution that supports various data types, refere
 
 - recent GNU make
 - gcc with recent enough C23 support
-- zig 0.13.0
+- zig 0.14.0
 - npm & node.js, v20.11.1 or newer
 
 ```bash
@@ -60,401 +60,3 @@ Builds nothing only runs tests
 ```bash
 npm run test-fast
 ```
-
-## Getting Started
-
-To get started with BasedDb, follow these steps:
-
-1. Install the package
-2. Define your schema
-3. Start the database
-4. Perform operations like create, query, update, and delete
-
-```ts
-const db = new BasedDb({
-  path: '/persistent-file-path',
-})
-```
-
-## Schema Definition
-
-Define your schema using the `setSchema` method. Here is an example:
-
-```typescript
-await db.setSchema({
-  types: {
-    user: {
-      name: 'string',
-      age: 'number',
-      email: 'alias',
-      isNice: 'boolean',
-      roles: ['admin', 'editor', 'viewer'],
-      file: 'binary',
-      bestFriend: {
-        ref: 'user',
-        prop: 'bestFriend',
-      },
-      friends: {
-        items: {
-          ref: 'user',
-          prop: 'friends',
-        },
-      },
-    },
-    article: {
-      body: 'string',
-      myUniqueValuesCount: 'cardinality',
-      contributors: {
-        type: 'references',
-        items: {
-          ref: 'user',
-          prop: 'articles',
-          $role: ['writer', 'editor'],
-        },
-      },
-    },
-    page: {
-      name: 'string',
-      clients: {
-        items: {
-          ref: '_client',
-          prop: 'pages',
-          $viewers: 'uint8',
-        },
-      },
-      activeViewers: {
-        type: 'uint32',
-        path: 'clients.$viewers.#sum',
-        history: {
-          interval: 'second',
-        },
-      },
-    },
-    _client: {
-      name: 'string',
-    },
-  },
-})
-```
-
-## Data Operations
-
-### Create
-
-Create new records using the `create` method:
-
-```typescript
-const userId = await db.create('user', {
-  name: 'youzi',
-  email: 'youzi@example.com',
-  isNice: true,
-  roles: 'admin',
-})
-```
-
-### Query & Filters
-
-Query records using the `query` method:
-
-```typescript
-const results = await db
-  .query('user')
-  .filter('isNice', '=', true)
-  .filter('name', '=', 'youzi')
-  .get()
-  .toObject()
-```
-
-### Update
-
-Update records using the `update` method:
-
-```typescript
-await db.update('user', userId, {
-  roles: 'editor',
-})
-```
-
-### Delete
-
-Delete records using the `delete` method:
-
-```typescript
-await db.delete('user', userId)
-```
-
-## Advanced Features
-
-### Copy
-
-Copy records with transformations:
-
-```typescript
-await db.copy('edition', editionId, {
-  copiedByYouzi: true,
-  versionOf({ id }) {
-    return id
-  },
-  name({ name }) {
-    return name + ' (edition copy)'
-  },
-  sequences({ sequences }) {
-    return sequences.map(({ id }) => {
-      return db.copy('sequence', id, {
-        copiedByYouzi: true,
-        name({ name }) {
-          return name + ' (sequence copy)'
-        },
-        pages({ pages }) {
-          return pages.map(({ id }) =>
-            db.copy('page', id, {
-              copiedByYouzi: true,
-              name({ name }) {
-                return name + ' (page copy)'
-              },
-            }),
-          )
-        },
-      })
-    })
-  },
-})
-```
-
-### Concurrency
-
-Concurrent write and read operations are supported. The example below shows multiple concurrent queries and creates. Handle concurrency carefully to avoid conflicts:
-
-```typescript
-let id = 0
-let queries = 0
-let refs = []
-let timer = setTimeout(() => {
-  timer = null
-}, 5e3)
-
-const query = async () => {
-  queries++
-  try {
-    await db.query('user').include('friends').range(0, 1000_000).get()
-  } catch (e) {
-    console.error('err:', e)
-  }
-  queries--
-}
-
-while (timer) {
-  let i = 100
-  while (i--) {
-    query()
-  }
-  while (timer && queries) {
-    db.create('user', {
-      friends: refs,
-    })
-    refs.push(++id)
-    await db.drain()
-    await setTimeoutAsync()
-  }
-}
-
-clearTimeout(timer)
-```
-
-### Client-Server
-
-Set up a client-server architecture:
-
-```typescript
-const server = new DbServer({
-  path: t.tmp,
-  onSchemaChange(schema) {
-    client1.putLocalSchema(schema)
-    client2.putLocalSchema(schema)
-  },
-})
-
-await server.start({ clean: true })
-
-const hooks: DbClientHooks = {
-  async setSchema(schema, fromStart, transformFns) {
-    return server.setSchema(schema, fromStart, transformFns)
-  },
-  async flushModify(buf) {
-    const offsets = server.modify(buf)
-    return { offsets }
-  },
-  async getQueryBuf(buf) {
-    return server.getQueryBuf(buf)
-  },
-}
-
-const client1 = new DbClient({ hooks })
-const client2 = new DbClient({ hooks })
-
-await client1.setSchema({
-  types: {
-    user: {
-      name: 'string',
-    },
-  },
-})
-
-const youzi = await client1.create('user', { name: 'youzi' })
-const jamez = await client1.create('user', { name: 'jamez' })
-
-deepEqual(await client1.query('user').get().toObject(), [
-  { id: 1, name: 'youzi' },
-  { id: 2, name: 'jamez' },
-])
-```
-
-### Checksum
-
-Include checksum in queries:
-
-```typescript
-await db.query('article').include('*', '_checksum')
-```
-
-### Cardinality
-
-Use cardinality for unique value counts:
-
-```typescript
-await db.setSchema({
-  types: {
-    article: {
-      myUniqueValuesCount: 'cardinality',
-    },
-  },
-})
-
-const myArticle = await db.create('article', {
-  myUniqueValuesCount: 'myCoolValue',
-})
-```
-
-### Boolean
-
-Handle boolean properties:
-
-```typescript
-await db.setSchema({
-  types: {
-    user: {
-      props: {
-        isNice: 'boolean',
-      },
-    },
-  },
-})
-
-db.create('user', {})
-db.create('user', { isNice: true })
-db.create('user', { isNice: false })
-
-await db.drain()
-
-deepEqual((await db.query('user').get()).toObject(), [
-  { id: 1, isNice: false },
-  { id: 2, isNice: true },
-  { id: 3, isNice: false },
-])
-```
-
-### Binary
-
-Handle binary data:
-
-```typescript
-await db.setSchema({
-  types: {
-    user: {
-      props: {
-        file: { type: 'binary' },
-      },
-    },
-  },
-})
-
-db.create('user', {
-  file: new Uint32Array([1, 2, 3, 4]),
-})
-
-await db.drain()
-
-deepEqual((await db.query('user').get()).toObject(), [
-  {
-    id: 1,
-    file: new Uint8Array(new Uint32Array([1, 2, 3, 4]).buffer),
-  },
-])
-```
-
-### Analytics
-
-Perform analytics on data:
-
-```typescript
-await db.setSchema({
-  types: {
-    page: {
-      name: 'string',
-      clients: {
-        items: {
-          ref: '_client',
-          prop: 'pages',
-          $viewers: 'uint8',
-        },
-      },
-      activeViewers: {
-        type: 'uint32',
-        path: 'clients.$viewers.#sum',
-        history: {
-          interval: 'second',
-        },
-      },
-    },
-  },
-})
-
-const client = await db.create('_client', {})
-const page = await db.create('page', {
-  clients: [
-    {
-      id: client,
-      $viewers: { increment: 1 },
-    },
-  ],
-})
-```
-
-### Alias
-
-Use aliases for properties:
-
-```typescript
-await db.setSchema({
-  types: {
-    user: {
-      props: {
-        externalId: 'alias',
-        potato: 'string',
-      },
-    },
-  },
-})
-
-const user1 = db.create('user', {
-  externalId: 'cool',
-})
-
-await db.drain()
-
-deepEqual((await db.query('user', user1).get()).toObject(), {
-  id: 1,
-  externalId: 'cool',
-  potato: '',
-})
-```

package/dist/lib/darwin_aarch64/include/selva/db.h

@@ -4,6 +4,7 @@
  */
 #pragma once
 
+#include <assert.h>
 #include <sys/types.h>
 #include "selva/_export.h"
 #include "selva/types.h"
@@ -179,13 +180,16 @@ inline enum SelvaFieldType selva_get_fs_type(const struct SelvaFieldSchema *fs)
  * struct SelvaFieldSchema *dst_fs = selva_get_fs_by_node(db, dst, efc->inverse_field);
  */
 SELVA_EXPORT
+__attribute__((returns_nonnull))
 __attribute__((nonnull))
 inline const struct EdgeFieldConstraint *selva_get_edge_field_constraint(const struct SelvaFieldSchema *fs)
 #ifndef __zig
 {
-    return (fs->type == SELVA_FIELD_TYPE_REFERENCE || fs->type == SELVA_FIELD_TYPE_REFERENCES)
-        ? &fs->edge_constraint
-        : nullptr;
+    assert(fs->type == SELVA_FIELD_TYPE_REFERENCE ||
+           fs->type == SELVA_FIELD_TYPE_REFERENCES ||
+           fs->type == SELVA_FIELD_TYPE_WEAK_REFERENCE ||
+           fs->type == SELVA_FIELD_TYPE_WEAK_REFERENCES);
+    return &fs->edge_constraint;
 }
 #else
 ;
@@ -349,7 +353,7 @@ SELVA_EXPORT
 selva_hash128_t selva_node_hash(struct SelvaDb *db, struct SelvaTypeEntry *type, struct SelvaNode *node);
 
 SELVA_EXPORT
-selva_hash128_t selva_node_hash_range(struct SelvaDb *db, struct SelvaTypeEntry *type, node_id_t start, node_id_t end) __attribute__((nonnull));
+int selva_node_hash_range(struct SelvaDb *db, struct SelvaTypeEntry *type, node_id_t start, node_id_t end, selva_hash128_t *hash_out) __attribute__((nonnull, warn_unused_result));
 
 /**
  * @}

package/dist/lib/darwin_aarch64/include/selva/selva_hash128.h

@@ -1,25 +1,33 @@
 /*
- * Copyright (c) 2024 SAULX
+ * Copyright (c) 2024-2025 SAULX
  * SPDX-License-Identifier: MIT
  */
 #pragma once
 #include "xxhash.h"
+#include "jemalloc_selva.h"
 #include "selva/types.h"
 
 typedef struct XXH3_state_s selva_hash_state_t;
 
-#define selva_hash_create_state XXH3_createState
 #define selva_hash_reset XXH3_128bits_reset
-#define selva_hash_free_state XXH3_freeState
 #define selva_hash_update XXH3_128bits_update
 
 SELVA_EXPORT
-selva_hash128_t selva_hash_digest_zig(selva_hash_state_t *hash_state);
+selva_hash_state_t *selva_hash_create_state(void);
 
-#ifdef __zig
-#define selva_hash_digest selva_hash_digest_zig
+SELVA_EXPORT
+inline void selva_hash_free_state(selva_hash_state_t *state)
+#ifndef __zig
+{
+    selva_free(state);
+}
 #else
-static inline selva_hash128_t selva_hash_digest(selva_hash_state_t *hash_state)
+;
+#endif
+
+SELVA_EXPORT
+inline selva_hash128_t selva_hash_digest(selva_hash_state_t *hash_state)
+#ifndef __zig
 {
     XXH128_hash_t res;
 
@@ -36,4 +44,6 @@ retry:
 
     return (selva_hash128_t)res.low64 | (selva_hash128_t)res.high64 << 64;
 }
+#else
+;
 #endif

package/dist/lib/darwin_aarch64/include/selva/sort.h

@@ -40,8 +40,13 @@ enum SelvaSortOrder {
     SELVA_SORT_ORDER_TEXT_DESC,
 };
 
+struct SelvaSortItem;
 struct SelvaSortCtx;
 
+struct SelvaSortIterator {
+    struct SelvaSortItem *next;
+};
+
 SELVA_EXPORT
 struct SelvaSortCtx *selva_sort_init(enum SelvaSortOrder order);
 
@@ -91,43 +96,45 @@ SELVA_EXPORT
 void selva_sort_remove_text(struct SelvaSortCtx *ctx, const char *str, size_t len, const void *p);
 
 SELVA_EXPORT
-void selva_sort_foreach_begin(struct SelvaSortCtx *ctx);
+void selva_sort_foreach_begin(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it);
 
 SELVA_EXPORT
-void selva_sort_foreach_begin_reverse(struct SelvaSortCtx *ctx);
+void selva_sort_foreach_begin_reverse(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it);
 
 SELVA_EXPORT
-void *selva_sort_foreach(struct SelvaSortCtx *ctx);
+void *selva_sort_foreach(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it);
 
 SELVA_EXPORT
-void *selva_sort_foreach_reverse(struct SelvaSortCtx *ctx);
+void *selva_sort_foreach_reverse(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it);
 
 SELVA_EXPORT
-void *selva_sort_foreach_i64(struct SelvaSortCtx *ctx, int64_t *v);
+void *selva_sort_foreach_i64(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it, int64_t *v);
 
 SELVA_EXPORT
-void *selva_sort_foreach_i64_reverse(struct SelvaSortCtx *ctx, int64_t *v);
+void *selva_sort_foreach_i64_reverse(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it, int64_t *v);
 
 SELVA_EXPORT
-void *selva_sort_foreach_float(struct SelvaSortCtx *ctx, float *f);
+void *selva_sort_foreach_float(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it, float *f);
 
 SELVA_EXPORT
-void *selva_sort_foreach_float_reverse(struct SelvaSortCtx *ctx, float *f);
+void *selva_sort_foreach_float_reverse(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it, float *f);
 
 SELVA_EXPORT
-void *selva_sort_foreach_double(struct SelvaSortCtx *ctx, double *d);
+void *selva_sort_foreach_double(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it, double *d);
 
 SELVA_EXPORT
-void *selva_sort_foreach_double_reverse(struct SelvaSortCtx *ctx, double *d);
+void *selva_sort_foreach_double_reverse(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it, double *d);
 
 SELVA_EXPORT
-void *selva_sort_foreach_buffer(struct SelvaSortCtx *ctx, void **buf, size_t *len);
+void *selva_sort_foreach_buffer(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it, void **buf, size_t *len);
 
 SELVA_EXPORT
-void *selva_sort_foreach_buffer_reverse(struct SelvaSortCtx *ctx, void **buf, size_t *len);
+void *selva_sort_foreach_buffer_reverse(struct SelvaSortCtx *ctx, struct SelvaSortIterator *it, void **buf, size_t *len);
 
-SELVA_EXPORT
-bool selva_sort_foreach_done(const struct SelvaSortCtx *ctx);
+static inline bool selva_sort_foreach_done(struct SelvaSortIterator *it)
+{
+    return !it->next;
+}
 
 SELVA_EXPORT
 int selva_sort_defrag(struct SelvaSortCtx *ctx);

package/dist/lib/linux_aarch64/include/selva/db.h

@@ -4,6 +4,7 @@
  */
 #pragma once
 
+#include <assert.h>
 #include <sys/types.h>
 #include "selva/_export.h"
 #include "selva/types.h"
@@ -179,13 +180,16 @@ inline enum SelvaFieldType selva_get_fs_type(const struct SelvaFieldSchema *fs)
  * struct SelvaFieldSchema *dst_fs = selva_get_fs_by_node(db, dst, efc->inverse_field);
  */
 SELVA_EXPORT
+__attribute__((returns_nonnull))
 __attribute__((nonnull))
 inline const struct EdgeFieldConstraint *selva_get_edge_field_constraint(const struct SelvaFieldSchema *fs)
 #ifndef __zig
 {
-    return (fs->type == SELVA_FIELD_TYPE_REFERENCE || fs->type == SELVA_FIELD_TYPE_REFERENCES)
-        ? &fs->edge_constraint
-        : nullptr;
+    assert(fs->type == SELVA_FIELD_TYPE_REFERENCE ||
+           fs->type == SELVA_FIELD_TYPE_REFERENCES ||
+           fs->type == SELVA_FIELD_TYPE_WEAK_REFERENCE ||
+           fs->type == SELVA_FIELD_TYPE_WEAK_REFERENCES);
+    return &fs->edge_constraint;
 }
 #else
 ;
@@ -349,7 +353,7 @@ SELVA_EXPORT
 selva_hash128_t selva_node_hash(struct SelvaDb *db, struct SelvaTypeEntry *type, struct SelvaNode *node);
 
 SELVA_EXPORT
-selva_hash128_t selva_node_hash_range(struct SelvaDb *db, struct SelvaTypeEntry *type, node_id_t start, node_id_t end) __attribute__((nonnull));
+int selva_node_hash_range(struct SelvaDb *db, struct SelvaTypeEntry *type, node_id_t start, node_id_t end, selva_hash128_t *hash_out) __attribute__((nonnull, warn_unused_result));
 
 /**
  * @}

package/dist/lib/linux_aarch64/include/selva/selva_hash128.h

@@ -1,25 +1,33 @@
 /*
- * Copyright (c) 2024 SAULX
+ * Copyright (c) 2024-2025 SAULX
  * SPDX-License-Identifier: MIT
  */
 #pragma once
 #include "xxhash.h"
+#include "jemalloc_selva.h"
 #include "selva/types.h"
 
 typedef struct XXH3_state_s selva_hash_state_t;
 
-#define selva_hash_create_state XXH3_createState
 #define selva_hash_reset XXH3_128bits_reset
-#define selva_hash_free_state XXH3_freeState
 #define selva_hash_update XXH3_128bits_update
 
 SELVA_EXPORT
-selva_hash128_t selva_hash_digest_zig(selva_hash_state_t *hash_state);
+selva_hash_state_t *selva_hash_create_state(void);
 
-#ifdef __zig
-#define selva_hash_digest selva_hash_digest_zig
+SELVA_EXPORT
+inline void selva_hash_free_state(selva_hash_state_t *state)
+#ifndef __zig
+{
+    selva_free(state);
+}
 #else
-static inline selva_hash128_t selva_hash_digest(selva_hash_state_t *hash_state)
+;
+#endif
+
+SELVA_EXPORT
+inline selva_hash128_t selva_hash_digest(selva_hash_state_t *hash_state)
+#ifndef __zig
 {
     XXH128_hash_t res;
 
@@ -36,4 +44,6 @@ retry:
 
     return (selva_hash128_t)res.low64 | (selva_hash128_t)res.high64 << 64;
 }
+#else
+;
 #endif