klauz-db 0.5.2 → 1.0.5

package/dist/index.cjs

@@ -0,0 +1,395 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  KlauzDB: () => KlauzDB,
+  KlauzError: () => KlauzError,
+  KlauzNotFoundError: () => KlauzNotFoundError,
+  KlauzStorageError: () => KlauzStorageError,
+  KlauzValidationError: () => KlauzValidationError
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/collection.ts
+var import_node_path2 = require("path");
+
+// src/errors/error-message.ts
+var import_zod = require("zod");
+
+// src/errors/klauz-error.ts
+var KlauzError = class extends Error {
+  constructor(message, code = "KLAUZ_ERROR", options) {
+    super(message, options);
+    this.code = code;
+    this.name = "KlauzError";
+  }
+  code;
+};
+var KlauzValidationError = class extends KlauzError {
+  constructor(message, options) {
+    super(message, "KLAUZ_VALIDATION_ERROR", options);
+    this.name = "KlauzValidationError";
+  }
+};
+var KlauzStorageError = class extends KlauzError {
+  constructor(message, options) {
+    super(message, "KLAUZ_STORAGE_ERROR", options);
+    this.name = "KlauzStorageError";
+  }
+};
+var KlauzNotFoundError = class extends KlauzError {
+  constructor(message, options) {
+    super(message, "KLAUZ_NOT_FOUND", options);
+    this.name = "KlauzNotFoundError";
+  }
+};
+
+// src/errors/error-message.ts
+function errorMessage(err) {
+  if (err instanceof import_zod.ZodError) {
+    const error = err.errors.at(-1);
+    return {
+      error: error?.message ?? "Invalid params",
+      code: "KLAUZ_VALIDATION_ERROR"
+    };
+  }
+  if (err instanceof KlauzError || err instanceof KlauzValidationError) {
+    return {
+      error: err.message,
+      code: err.code
+    };
+  }
+  if (err instanceof Error) {
+    return {
+      error: err.message,
+      code: "KLAUZ_ERROR"
+    };
+  }
+  return {
+    error: "Unknown error",
+    code: "KLAUZ_ERROR"
+  };
+}
+
+// src/schemas/collection-schemas.ts
+var import_zod2 = __toESM(require("zod"));
+var collectionNamePattern = /^[a-zA-Z0-9_-]+$/;
+function parseSchema(schema, data) {
+  const result = schema.safeParse(data);
+  if (!result.success) {
+    const error = result.error.errors.at(-1);
+    throw new KlauzValidationError(error?.message ?? "Invalid params", {
+      cause: result.error
+    });
+  }
+  return result.data;
+}
+var klauzPropsSchema = import_zod2.default.object({
+  path: import_zod2.default.string().trim().min(1)
+}).strict();
+var collectionNameSchema = import_zod2.default.string().trim().min(1).regex(collectionNamePattern, "Collection name must contain only letters, numbers, hyphens and underscores");
+var collectionDataSchema = import_zod2.default.record(
+  import_zod2.default.string(),
+  import_zod2.default.unknown(),
+  { message: `Content must be a object. Use 'addMany' method, to insert a new array` }
+);
+var collectionDataArraySchema = import_zod2.default.array(collectionDataSchema);
+var findAllOptionsSchema = import_zod2.default.object({
+  hideInfo: import_zod2.default.array(import_zod2.default.string().min(1)).optional()
+}).strict().optional();
+var findOptionsSchema = import_zod2.default.object({
+  where: import_zod2.default.function(),
+  hideInfo: import_zod2.default.array(import_zod2.default.string().min(1)).optional()
+}).strict();
+var updateOptionsSchema = import_zod2.default.object({
+  where: import_zod2.default.function(),
+  values: collectionDataSchema
+}).strict();
+var deleteOptionsSchema = import_zod2.default.object({
+  where: import_zod2.default.function()
+}).strict();
+
+// src/storage/json-storage.ts
+var import_promises = require("fs/promises");
+var import_node_path = require("path");
+var JsonStorage = class {
+  constructor(filePath) {
+    this.filePath = filePath;
+  }
+  filePath;
+  async exists() {
+    try {
+      await (0, import_promises.access)(this.filePath);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+  async read() {
+    const content = await (0, import_promises.readFile)(this.filePath, {
+      encoding: "utf-8"
+    });
+    return JSON.parse(content);
+  }
+  async write(data) {
+    await (0, import_promises.mkdir)((0, import_node_path.dirname)(this.filePath), {
+      recursive: true
+    });
+    await (0, import_promises.writeFile)(this.filePath, JSON.stringify(data, null, 2));
+  }
+  async delete() {
+    await (0, import_promises.unlink)(this.filePath);
+  }
+};
+
+// src/collection.ts
+var Collection = class {
+  constructor(props) {
+    this.props = props;
+    const fileExtension = ".json";
+    const { path, name } = props;
+    this.#name = name;
+    this.#path = (0, import_node_path2.join)(path, `.${name}${fileExtension}`);
+    this.#storage = new JsonStorage(this.#path);
+  }
+  props;
+  #name;
+  #path;
+  #storage;
+  #content = {};
+  async init() {
+    await this.#load();
+    return this;
+  }
+  async #load() {
+    if (!await this.#storage.exists()) {
+      const content = {
+        collection_name: this.#name,
+        created_at: (/* @__PURE__ */ new Date()).toISOString(),
+        updated_at: (/* @__PURE__ */ new Date()).toISOString(),
+        data: []
+      };
+      this.#content = content;
+      await this.#save(this.#content);
+      return;
+    }
+    try {
+      const content = await this.#storage.read();
+      this.#content = this.#normalizeContent(content);
+    } catch (err) {
+      throw new KlauzStorageError("Invalid collection JSON file", { cause: err });
+    }
+  }
+  #normalizeContent(content) {
+    const updatedAt = content.updated_at ?? content.last_interaction ?? content.created_at;
+    return {
+      collection_name: content.collection_name,
+      created_at: content.created_at,
+      updated_at: updatedAt,
+      data: content.data
+    };
+  }
+  async #save(content) {
+    await this.#storage.write(content);
+  }
+  async #setCollectionDataValue(data) {
+    this.#content.updated_at = (/* @__PURE__ */ new Date()).toISOString();
+    this.#content.data.push(data);
+    await this.#save(this.#content);
+  }
+  async #setCollectionData(data) {
+    this.#content.updated_at = (/* @__PURE__ */ new Date()).toISOString();
+    this.#content.data = data;
+    await this.#save(this.#content);
+  }
+  async #getCollectionData() {
+    await this.#load();
+    return this.#content.data;
+  }
+  #getLastNumericId(data = this.#content.data) {
+    const lastObject = data.findLast((obj) => typeof obj._zid === "number");
+    return lastObject?._zid ?? 0;
+  }
+  #removeInternalFields(data) {
+    const safeData = { ...data };
+    Reflect.deleteProperty(safeData, "_zid");
+    return safeData;
+  }
+  #cloneData(data) {
+    return data.map((obj) => ({ ...obj }));
+  }
+  #hideInfo(data, hideInfo) {
+    const output = this.#cloneData(data);
+    if (!hideInfo || hideInfo.length === 0) return output;
+    for (const obj of output) {
+      for (const info of hideInfo) {
+        Reflect.deleteProperty(obj, info);
+      }
+    }
+    return output;
+  }
+  get information() {
+    return this.#getInformation();
+  }
+  async #getInformation() {
+    await this.#load();
+    return {
+      collection_name: this.#content.collection_name,
+      created_at: this.#content.created_at,
+      updated_at: this.#content.updated_at
+    };
+  }
+  async add(data) {
+    try {
+      if (arguments.length > 1) throw Error("Invalid params");
+      await this.#load();
+      const obj = this.#removeInternalFields(parseSchema(collectionDataSchema, data));
+      const lastId = this.#getLastNumericId();
+      Reflect.set(obj, "_zid", lastId + 1);
+      await this.#setCollectionDataValue(obj);
+      return { ...obj };
+    } catch (err) {
+      return errorMessage(err);
+    }
+  }
+  async addMany(data) {
+    try {
+      if (arguments.length > 1) throw Error("Invalid params");
+      await this.#load();
+      const objs = parseSchema(collectionDataArraySchema, data).map((obj) => this.#removeInternalFields(obj));
+      let lastId = this.#getLastNumericId();
+      for (const obj of objs) {
+        Reflect.set(obj, "_zid", ++lastId);
+      }
+      await this.#setCollectionData([
+        ...this.#content.data,
+        ...objs
+      ]);
+      return this.#cloneData(objs);
+    } catch (err) {
+      return errorMessage(err);
+    }
+  }
+  async findAll(options) {
+    try {
+      if (arguments.length > 1) throw Error("Invalid params");
+      const collectionData = await this.#getCollectionData();
+      const zOpts = parseSchema(findAllOptionsSchema, options);
+      return this.#hideInfo(collectionData, zOpts?.hideInfo);
+    } catch (err) {
+      return errorMessage(err);
+    }
+  }
+  async find(options) {
+    try {
+      if (arguments.length > 1) throw Error("Invalid params");
+      const { where, ...opts } = parseSchema(findOptionsSchema, options);
+      const collectionData = await this.#getCollectionData();
+      const output = collectionData.filter((obj) => where.call(void 0, obj));
+      return this.#hideInfo(output, opts.hideInfo);
+    } catch (err) {
+      return errorMessage(err);
+    }
+  }
+  async update(options) {
+    try {
+      if (arguments.length > 1) throw Error("Invalid params");
+      const { where, values } = parseSchema(updateOptionsSchema, options);
+      const safeValues = this.#removeInternalFields(values ?? {});
+      const collectionData = await this.#getCollectionData();
+      const output = [];
+      for (const obj of collectionData) {
+        if (where.call(void 0, obj)) {
+          Object.assign(obj, {
+            ...obj,
+            ...safeValues,
+            _zid: obj._zid
+          });
+          output.push({ ...obj });
+        }
+      }
+      if (output.length === 0) throw Error("Data not found");
+      await this.#setCollectionData(collectionData);
+      return output;
+    } catch (err) {
+      return errorMessage(err);
+    }
+  }
+  async delete(options) {
+    try {
+      if (arguments.length > 1) throw Error("Invalid params");
+      const { where } = parseSchema(deleteOptionsSchema, options);
+      const collectionData = await this.#getCollectionData();
+      const dataPostDelete = collectionData.filter((obj) => !where(obj));
+      if (collectionData.length === dataPostDelete.length) return;
+      await this.#setCollectionData(dataPostDelete);
+    } catch (err) {
+      return errorMessage(err);
+    }
+  }
+  async reset() {
+    try {
+      await this.#load();
+      await this.#setCollectionData([]);
+    } catch (err) {
+      return errorMessage(err);
+    }
+  }
+  async drop() {
+    await this.#storage.delete();
+  }
+};
+
+// src/klauz-db.ts
+var KlauzDB = class {
+  path = "";
+  constructor(props) {
+    const { path } = parseSchema(klauzPropsSchema, props);
+    this.path = path;
+  }
+  async createCollection(collectionName) {
+    const name = parseSchema(collectionNameSchema, collectionName);
+    const collection = new Collection({
+      name,
+      path: this.path
+    });
+    return collection.init();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  KlauzDB,
+  KlauzError,
+  KlauzNotFoundError,
+  KlauzStorageError,
+  KlauzValidationError
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/collection.ts","../src/errors/error-message.ts","../src/errors/klauz-error.ts","../src/schemas/collection-schemas.ts","../src/storage/json-storage.ts","../src/klauz-db.ts"],"sourcesContent":["export * from './klauz-db'\nexport * from './types'\nexport * from './errors/klauz-error'\n","import { join } from \"node:path\";\r\nimport { errorMessage } from \"./errors/error-message\";\r\nimport { KlauzStorageError } from \"./errors/klauz-error\";\r\nimport {\r\n    collectionDataArraySchema,\r\n    collectionDataSchema,\r\n    deleteOptionsSchema,\r\n    findAllOptionsSchema,\r\n    findOptionsSchema,\r\n    parseSchema,\r\n    updateOptionsSchema\r\n} from \"./schemas/collection-schemas\";\r\nimport { JsonStorage } from \"./storage/json-storage\";\r\nimport {\r\n    CollectionContent,\n    CollectionData,\n    CollectionDataWithZID,\n    CollectionProps,\n    DeleteOptions,\n    FindOptions,\n    FindOptionsWithoutWhere,\n    KzObject,\n    LegacyCollectionContent,\n    Output,\n    UpdateOptions,\n    ZID\n} from \"./types\";\r\n\r\nexport class Collection {\r\n    readonly #name: string\r\n    readonly #path: string\r\n    readonly #storage: JsonStorage\r\n    #content = {} as CollectionContent\r\n\r\n    constructor(private readonly props: CollectionProps) {\r\n        const fileExtension = '.json'\r\n        const { path, name } = props\r\n        this.#name = name\r\n        this.#path = join(path, `.${name}${fileExtension}`)\r\n        this.#storage = new JsonStorage(this.#path)\r\n    }\r\n\r\n    async init(): Promise<this> {\r\n        await this.#load()\r\n        return this\r\n    }\r\n\r\n    async #load(): Promise<void> {\r\n        if (!await this.#storage.exists()) {\r\n            const content: CollectionContent = {\r\n                collection_name: this.#name,\n                created_at: new Date().toISOString(),\n                updated_at: new Date().toISOString(),\n                data: []\n            }\n            this.#content = content\r\n            await this.#save(this.#content)\r\n            return\r\n        }\n\n        try {\n            const content = await this.#storage.read<LegacyCollectionContent>()\n            this.#content = this.#normalizeContent(content)\n        } catch (err) {\n            throw new KlauzStorageError('Invalid collection JSON file', { cause: err })\n        }\n    }\n\n    #normalizeContent(content: LegacyCollectionContent): CollectionContent {\n        const updatedAt = content.updated_at ?? content.last_interaction ?? content.created_at\n\n        return {\n            collection_name: content.collection_name,\n            created_at: content.created_at,\n            updated_at: updatedAt,\n            data: content.data\n        }\n    }\n\r\n    async #save(content: CollectionContent): Promise<void> {\r\n        await this.#storage.write(content)\r\n    }\r\n\r\n    async #setCollectionDataValue(data: CollectionDataWithZID): Promise<void> {\n        this.#content.updated_at = new Date().toISOString()\n        this.#content.data.push(data)\n        await this.#save(this.#content)\n    }\n\n    async #setCollectionData(data: CollectionDataWithZID[]): Promise<void> {\n        this.#content.updated_at = new Date().toISOString()\n        this.#content.data = data\n        await this.#save(this.#content)\n    }\r\n\r\n    async #getCollectionData(): Promise<CollectionDataWithZID[]> {\r\n        await this.#load()\r\n        return this.#content.data\r\n    }\r\n\r\n    #getLastNumericId(data = this.#content.data): ZID {\r\n        const lastObject = data.findLast((obj: CollectionDataWithZID) => typeof obj._zid === 'number')\r\n        return lastObject?._zid ?? 0\r\n    }\r\n\r\n    #removeInternalFields(data: CollectionData): CollectionData {\r\n        const safeData = { ...data }\r\n        Reflect.deleteProperty(safeData, '_zid')\r\n        return safeData\r\n    }\r\n\r\n    #cloneData(data: CollectionDataWithZID[]): CollectionDataWithZID[] {\r\n        return data.map((obj) => ({ ...obj }))\r\n    }\r\n\r\n    #hideInfo(data: CollectionDataWithZID[], hideInfo?: string[]): CollectionDataWithZID[] {\r\n        const output = this.#cloneData(data)\r\n\r\n        if (!hideInfo || hideInfo.length === 0) return output\r\n\r\n        for (const obj of output) {\r\n            for (const info of hideInfo) {\r\n                Reflect.deleteProperty(obj, info)\r\n            }\r\n        }\r\n\r\n        return output\r\n    }\r\n\r\n    get information(): Promise<Omit<CollectionContent, 'data'>> {\r\n        return this.#getInformation()\r\n    }\r\n\r\n    async #getInformation(): Promise<Omit<CollectionContent, 'data'>> {\r\n        await this.#load()\r\n        return {\r\n            collection_name: this.#content.collection_name,\n            created_at: this.#content.created_at,\n            updated_at: this.#content.updated_at,\n        }\n    }\n\r\n    async add(data: CollectionData): Promise<Output<CollectionDataWithZID>> {\r\n        try {\r\n            if (arguments.length > 1) throw Error('Invalid params')\r\n            await this.#load()\r\n            const obj = this.#removeInternalFields(parseSchema(collectionDataSchema, data)) as CollectionDataWithZID\r\n            const lastId = this.#getLastNumericId()\r\n            Reflect.set(obj, '_zid', lastId + 1)\r\n            await this.#setCollectionDataValue(obj)\r\n            return { ...obj }\r\n        } catch (err) {\r\n            return errorMessage(err)\r\n        }\r\n    }\r\n\r\n    async addMany(data: CollectionData[]): Promise<Output<CollectionDataWithZID[]>> {\r\n        try {\r\n            if (arguments.length > 1) throw Error('Invalid params')\r\n            await this.#load()\r\n            const objs = parseSchema(collectionDataArraySchema, data).map((obj) => this.#removeInternalFields(obj)) as CollectionDataWithZID[]\r\n            let lastId = this.#getLastNumericId()\r\n\r\n            for (const obj of objs) {\r\n                Reflect.set(obj, '_zid', ++lastId)\r\n            }\r\n\r\n            await this.#setCollectionData([\r\n                ...this.#content.data,\r\n                ...objs\r\n            ])\r\n\r\n            return this.#cloneData(objs)\r\n        } catch (err) {\r\n            return errorMessage(err)\r\n        }\r\n    }\r\n\r\n    async findAll(options?: FindOptionsWithoutWhere): Promise<Output<CollectionDataWithZID[]>> {\r\n        try {\r\n            if (arguments.length > 1) throw Error('Invalid params')\r\n            const collectionData = await this.#getCollectionData()\r\n            const zOpts = parseSchema(findAllOptionsSchema, options) as FindOptionsWithoutWhere\r\n            return this.#hideInfo(collectionData, zOpts?.hideInfo)\r\n        } catch (err) {\r\n            return errorMessage(err)\r\n        }\r\n    }\r\n\r\n    async find<T>(options: FindOptions<KzObject<T>>): Promise<Output<CollectionDataWithZID[]>> {\r\n        try {\r\n            if (arguments.length > 1) throw Error('Invalid params')\r\n            const { where, ...opts } = parseSchema(findOptionsSchema, options) as FindOptions<T>\r\n            const collectionData = await this.#getCollectionData() as any\r\n            const output = collectionData.filter((obj: KzObject<T>) => where.call(undefined, obj)) as CollectionDataWithZID[]\r\n            return this.#hideInfo(output, opts.hideInfo)\r\n        } catch (err) {\r\n            return errorMessage(err)\r\n        }\r\n    }\r\n\r\n    async update<T>(options: UpdateOptions<KzObject<T>>): Promise<Output<CollectionDataWithZID[]>> {\r\n        try {\r\n            if (arguments.length > 1) throw Error('Invalid params')\r\n            const { where, values } = parseSchema(updateOptionsSchema, options) as UpdateOptions<T>\r\n            const safeValues = this.#removeInternalFields(values ?? {})\r\n            const collectionData = await this.#getCollectionData() as any\r\n            const output = [] as CollectionDataWithZID[]\r\n            for (const obj of collectionData) {\r\n                if (where.call(undefined, obj)) {\r\n                    Object.assign(obj, {\r\n                        ...obj,\r\n                        ...safeValues,\r\n                        _zid: obj._zid\r\n                    })\r\n                    output.push({ ...obj })\r\n                }\r\n            }\r\n            if (output.length === 0) throw Error('Data not found')\r\n            await this.#setCollectionData(collectionData)\r\n            return output\r\n        } catch (err) {\r\n            return errorMessage(err)\r\n        }\r\n    }\r\n\r\n    async delete<T>(options: DeleteOptions<KzObject<T>>): Promise<Output<void>> {\r\n        try {\r\n            if (arguments.length > 1) throw Error('Invalid params')\r\n            const { where } = parseSchema(deleteOptionsSchema, options) as DeleteOptions<T>\r\n            const collectionData = await this.#getCollectionData() as any\r\n            const dataPostDelete = collectionData.filter((obj: KzObject<T>) => !where(obj)) as CollectionDataWithZID[]\r\n            if (collectionData.length === dataPostDelete.length) return\r\n            await this.#setCollectionData(dataPostDelete)\r\n        } catch (err) {\r\n            return errorMessage(err)\r\n        }\r\n    }\r\n\r\n    async reset(): Promise<Output<void>> {\r\n        try {\r\n            await this.#load()\r\n            await this.#setCollectionData([])\r\n        } catch (err) {\r\n            return errorMessage(err)\r\n        }\r\n    }\r\n\r\n    async drop(): Promise<void> {\r\n        await this.#storage.delete()\r\n    }\r\n}\r\n","import { ZodError } from \"zod\"\nimport { KlauzError, KlauzValidationError } from \"./klauz-error\"\n\nexport function errorMessage(err: unknown) {\n    if (err instanceof ZodError) {\n        const error = err.errors.at(-1)\n        return {\n            error: error?.message ?? 'Invalid params',\n            code: 'KLAUZ_VALIDATION_ERROR'\n        }\n    }\n\n    if (err instanceof KlauzError || err instanceof KlauzValidationError) {\n        return {\n            error: err.message,\n            code: err.code\n        }\n    }\n\n    if (err instanceof Error) {\n        return {\n            error: err.message,\n            code: 'KLAUZ_ERROR'\n        }\n    }\n\n    return {\n        error: 'Unknown error',\n        code: 'KLAUZ_ERROR'\n    }\n}\n","export type KlauzErrorCode =\n    | 'KLAUZ_ERROR'\n    | 'KLAUZ_VALIDATION_ERROR'\n    | 'KLAUZ_STORAGE_ERROR'\n    | 'KLAUZ_NOT_FOUND'\n\nexport class KlauzError extends Error {\n    constructor(\n        message: string,\n        public readonly code: KlauzErrorCode = 'KLAUZ_ERROR',\n        options?: ErrorOptions\n    ) {\n        super(message, options)\n        this.name = 'KlauzError'\n    }\n}\n\nexport class KlauzValidationError extends KlauzError {\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, 'KLAUZ_VALIDATION_ERROR', options)\n        this.name = 'KlauzValidationError'\n    }\n}\n\nexport class KlauzStorageError extends KlauzError {\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, 'KLAUZ_STORAGE_ERROR', options)\n        this.name = 'KlauzStorageError'\n    }\n}\n\nexport class KlauzNotFoundError extends KlauzError {\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, 'KLAUZ_NOT_FOUND', options)\n        this.name = 'KlauzNotFoundError'\n    }\n}\n","import z from 'zod'\nimport { KlauzValidationError } from '../errors/klauz-error'\n\nconst collectionNamePattern = /^[a-zA-Z0-9_-]+$/\n\nexport function parseSchema<TSchema extends z.ZodTypeAny>(schema: TSchema, data: unknown): z.infer<TSchema> {\n    const result = schema.safeParse(data)\n\n    if (!result.success) {\n        const error = result.error.errors.at(-1)\n        throw new KlauzValidationError(error?.message ?? 'Invalid params', {\n            cause: result.error\n        })\n    }\n\n    return result.data\n}\n\nexport const klauzPropsSchema = z.object({\n    path: z.string().trim().min(1)\n}).strict()\n\nexport const collectionNameSchema = z\n    .string()\n    .trim()\n    .min(1)\n    .regex(collectionNamePattern, 'Collection name must contain only letters, numbers, hyphens and underscores')\n\nexport const collectionDataSchema = z.record(\n    z.string(),\n    z.unknown(),\n    { message: `Content must be a object. Use 'addMany' method, to insert a new array` }\n)\n\nexport const collectionDataArraySchema = z.array(collectionDataSchema)\n\nexport const findAllOptionsSchema = z.object({\n    hideInfo: z.array(z.string().min(1)).optional()\n}).strict().optional()\n\nexport const findOptionsSchema = z.object({\n    where: z.function(),\n    hideInfo: z.array(z.string().min(1)).optional()\n}).strict()\n\nexport const updateOptionsSchema = z.object({\n    where: z.function(),\n    values: collectionDataSchema\n}).strict()\n\nexport const deleteOptionsSchema = z.object({\n    where: z.function()\n}).strict()\n","import { access, mkdir, readFile, unlink, writeFile } from 'node:fs/promises'\nimport { dirname } from 'node:path'\n\nexport class JsonStorage {\n    constructor(private readonly filePath: string) {}\n\n    async exists(): Promise<boolean> {\n        try {\n            await access(this.filePath)\n            return true\n        } catch {\n            return false\n        }\n    }\n\n    async read<T>(): Promise<T> {\n        const content = await readFile(this.filePath, {\n            encoding: 'utf-8'\n        })\n\n        return JSON.parse(content) as T\n    }\n\n    async write<T>(data: T): Promise<void> {\n        await mkdir(dirname(this.filePath), {\n            recursive: true\n        })\n\n        await writeFile(this.filePath, JSON.stringify(data, null, 2))\n    }\n\n    async delete(): Promise<void> {\n        await unlink(this.filePath)\n    }\n}\n","import { Collection } from \"./collection\";\nimport { collectionNameSchema, klauzPropsSchema, parseSchema } from \"./schemas/collection-schemas\";\nimport { KlauzProps } from \"./types\";\n\nexport class KlauzDB {\n    public path: string = ''\n    \n    constructor(props: KlauzProps) {\n        const { path } = parseSchema(klauzPropsSchema, props)\n        this.path = path\n    }\n\n    async createCollection(collectionName: string): Promise<Collection> {\n        const name = parseSchema(collectionNameSchema, collectionName)\n        const collection = new Collection({\n            name,\n            path: this.path\n        })\n        return collection.init()\n    }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,oBAAqB;;;ACArB,iBAAyB;;;ACMlB,IAAM,aAAN,cAAyB,MAAM;AAAA,EAClC,YACI,SACgB,OAAuB,eACvC,SACF;AACE,UAAM,SAAS,OAAO;AAHN;AAIhB,SAAK,OAAO;AAAA,EAChB;AAAA,EALoB;AAMxB;AAEO,IAAM,uBAAN,cAAmC,WAAW;AAAA,EACjD,YAAY,SAAiB,SAAwB;AACjD,UAAM,SAAS,0BAA0B,OAAO;AAChD,SAAK,OAAO;AAAA,EAChB;AACJ;AAEO,IAAM,oBAAN,cAAgC,WAAW;AAAA,EAC9C,YAAY,SAAiB,SAAwB;AACjD,UAAM,SAAS,uBAAuB,OAAO;AAC7C,SAAK,OAAO;AAAA,EAChB;AACJ;AAEO,IAAM,qBAAN,cAAiC,WAAW;AAAA,EAC/C,YAAY,SAAiB,SAAwB;AACjD,UAAM,SAAS,mBAAmB,OAAO;AACzC,SAAK,OAAO;AAAA,EAChB;AACJ;;;ADjCO,SAAS,aAAa,KAAc;AACvC,MAAI,eAAe,qBAAU;AACzB,UAAM,QAAQ,IAAI,OAAO,GAAG,EAAE;AAC9B,WAAO;AAAA,MACH,OAAO,OAAO,WAAW;AAAA,MACzB,MAAM;AAAA,IACV;AAAA,EACJ;AAEA,MAAI,eAAe,cAAc,eAAe,sBAAsB;AAClE,WAAO;AAAA,MACH,OAAO,IAAI;AAAA,MACX,MAAM,IAAI;AAAA,IACd;AAAA,EACJ;AAEA,MAAI,eAAe,OAAO;AACtB,WAAO;AAAA,MACH,OAAO,IAAI;AAAA,MACX,MAAM;AAAA,IACV;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,OAAO;AAAA,IACP,MAAM;AAAA,EACV;AACJ;;;AE9BA,IAAAC,cAAc;AAGd,IAAM,wBAAwB;AAEvB,SAAS,YAA0C,QAAiB,MAAiC;AACxG,QAAM,SAAS,OAAO,UAAU,IAAI;AAEpC,MAAI,CAAC,OAAO,SAAS;AACjB,UAAM,QAAQ,OAAO,MAAM,OAAO,GAAG,EAAE;AACvC,UAAM,IAAI,qBAAqB,OAAO,WAAW,kBAAkB;AAAA,MAC/D,OAAO,OAAO;AAAA,IAClB,CAAC;AAAA,EACL;AAEA,SAAO,OAAO;AAClB;AAEO,IAAM,mBAAmB,YAAAC,QAAE,OAAO;AAAA,EACrC,MAAM,YAAAA,QAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC;AACjC,CAAC,EAAE,OAAO;AAEH,IAAM,uBAAuB,YAAAA,QAC/B,OAAO,EACP,KAAK,EACL,IAAI,CAAC,EACL,MAAM,uBAAuB,6EAA6E;AAExG,IAAM,uBAAuB,YAAAA,QAAE;AAAA,EAClC,YAAAA,QAAE,OAAO;AAAA,EACT,YAAAA,QAAE,QAAQ;AAAA,EACV,EAAE,SAAS,wEAAwE;AACvF;AAEO,IAAM,4BAA4B,YAAAA,QAAE,MAAM,oBAAoB;AAE9D,IAAM,uBAAuB,YAAAA,QAAE,OAAO;AAAA,EACzC,UAAU,YAAAA,QAAE,MAAM,YAAAA,QAAE,OAAO,EAAE,IAAI,CAAC,CAAC,EAAE,SAAS;AAClD,CAAC,EAAE,OAAO,EAAE,SAAS;AAEd,IAAM,oBAAoB,YAAAA,QAAE,OAAO;AAAA,EACtC,OAAO,YAAAA,QAAE,SAAS;AAAA,EAClB,UAAU,YAAAA,QAAE,MAAM,YAAAA,QAAE,OAAO,EAAE,IAAI,CAAC,CAAC,EAAE,SAAS;AAClD,CAAC,EAAE,OAAO;AAEH,IAAM,sBAAsB,YAAAA,QAAE,OAAO;AAAA,EACxC,OAAO,YAAAA,QAAE,SAAS;AAAA,EAClB,QAAQ;AACZ,CAAC,EAAE,OAAO;AAEH,IAAM,sBAAsB,YAAAA,QAAE,OAAO;AAAA,EACxC,OAAO,YAAAA,QAAE,SAAS;AACtB,CAAC,EAAE,OAAO;;;ACpDV,sBAA2D;AAC3D,uBAAwB;AAEjB,IAAM,cAAN,MAAkB;AAAA,EACrB,YAA6B,UAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,SAA2B;AAC7B,QAAI;AACA,gBAAM,wBAAO,KAAK,QAAQ;AAC1B,aAAO;AAAA,IACX,QAAQ;AACJ,aAAO;AAAA,IACX;AAAA,EACJ;AAAA,EAEA,MAAM,OAAsB;AACxB,UAAM,UAAU,UAAM,0BAAS,KAAK,UAAU;AAAA,MAC1C,UAAU;AAAA,IACd,CAAC;AAED,WAAO,KAAK,MAAM,OAAO;AAAA,EAC7B;AAAA,EAEA,MAAM,MAAS,MAAwB;AACnC,cAAM,2BAAM,0BAAQ,KAAK,QAAQ,GAAG;AAAA,MAChC,WAAW;AAAA,IACf,CAAC;AAED,cAAM,2BAAU,KAAK,UAAU,KAAK,UAAU,MAAM,MAAM,CAAC,CAAC;AAAA,EAChE;AAAA,EAEA,MAAM,SAAwB;AAC1B,cAAM,wBAAO,KAAK,QAAQ;AAAA,EAC9B;AACJ;;;AJNO,IAAM,aAAN,MAAiB;AAAA,EAMpB,YAA6B,OAAwB;AAAxB;AACzB,UAAM,gBAAgB;AACtB,UAAM,EAAE,MAAM,KAAK,IAAI;AACvB,SAAK,QAAQ;AACb,SAAK,YAAQ,wBAAK,MAAM,IAAI,IAAI,GAAG,aAAa,EAAE;AAClD,SAAK,WAAW,IAAI,YAAY,KAAK,KAAK;AAAA,EAC9C;AAAA,EAN6B;AAAA,EALpB;AAAA,EACA;AAAA,EACA;AAAA,EACT,WAAW,CAAC;AAAA,EAUZ,MAAM,OAAsB;AACxB,UAAM,KAAK,MAAM;AACjB,WAAO;AAAA,EACX;AAAA,EAEA,MAAM,QAAuB;AACzB,QAAI,CAAC,MAAM,KAAK,SAAS,OAAO,GAAG;AAC/B,YAAM,UAA6B;AAAA,QAC/B,iBAAiB,KAAK;AAAA,QACtB,aAAY,oBAAI,KAAK,GAAE,YAAY;AAAA,QACnC,aAAY,oBAAI,KAAK,GAAE,YAAY;AAAA,QACnC,MAAM,CAAC;AAAA,MACX;AACA,WAAK,WAAW;AAChB,YAAM,KAAK,MAAM,KAAK,QAAQ;AAC9B;AAAA,IACJ;AAEA,QAAI;AACA,YAAM,UAAU,MAAM,KAAK,SAAS,KAA8B;AAClE,WAAK,WAAW,KAAK,kBAAkB,OAAO;AAAA,IAClD,SAAS,KAAK;AACV,YAAM,IAAI,kBAAkB,gCAAgC,EAAE,OAAO,IAAI,CAAC;AAAA,IAC9E;AAAA,EACJ;AAAA,EAEA,kBAAkB,SAAqD;AACnE,UAAM,YAAY,QAAQ,cAAc,QAAQ,oBAAoB,QAAQ;AAE5E,WAAO;AAAA,MACH,iBAAiB,QAAQ;AAAA,MACzB,YAAY,QAAQ;AAAA,MACpB,YAAY;AAAA,MACZ,MAAM,QAAQ;AAAA,IAClB;AAAA,EACJ;AAAA,EAEA,MAAM,MAAM,SAA2C;AACnD,UAAM,KAAK,SAAS,MAAM,OAAO;AAAA,EACrC;AAAA,EAEA,MAAM,wBAAwB,MAA4C;AACtE,SAAK,SAAS,cAAa,oBAAI,KAAK,GAAE,YAAY;AAClD,SAAK,SAAS,KAAK,KAAK,IAAI;AAC5B,UAAM,KAAK,MAAM,KAAK,QAAQ;AAAA,EAClC;AAAA,EAEA,MAAM,mBAAmB,MAA8C;AACnE,SAAK,SAAS,cAAa,oBAAI,KAAK,GAAE,YAAY;AAClD,SAAK,SAAS,OAAO;AACrB,UAAM,KAAK,MAAM,KAAK,QAAQ;AAAA,EAClC;AAAA,EAEA,MAAM,qBAAuD;AACzD,UAAM,KAAK,MAAM;AACjB,WAAO,KAAK,SAAS;AAAA,EACzB;AAAA,EAEA,kBAAkB,OAAO,KAAK,SAAS,MAAW;AAC9C,UAAM,aAAa,KAAK,SAAS,CAAC,QAA+B,OAAO,IAAI,SAAS,QAAQ;AAC7F,WAAO,YAAY,QAAQ;AAAA,EAC/B;AAAA,EAEA,sBAAsB,MAAsC;AACxD,UAAM,WAAW,EAAE,GAAG,KAAK;AAC3B,YAAQ,eAAe,UAAU,MAAM;AACvC,WAAO;AAAA,EACX;AAAA,EAEA,WAAW,MAAwD;AAC/D,WAAO,KAAK,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,EAAE;AAAA,EACzC;AAAA,EAEA,UAAU,MAA+B,UAA8C;AACnF,UAAM,SAAS,KAAK,WAAW,IAAI;AAEnC,QAAI,CAAC,YAAY,SAAS,WAAW,EAAG,QAAO;AAE/C,eAAW,OAAO,QAAQ;AACtB,iBAAW,QAAQ,UAAU;AACzB,gBAAQ,eAAe,KAAK,IAAI;AAAA,MACpC;AAAA,IACJ;AAEA,WAAO;AAAA,EACX;AAAA,EAEA,IAAI,cAAwD;AACxD,WAAO,KAAK,gBAAgB;AAAA,EAChC;AAAA,EAEA,MAAM,kBAA4D;AAC9D,UAAM,KAAK,MAAM;AACjB,WAAO;AAAA,MACH,iBAAiB,KAAK,SAAS;AAAA,MAC/B,YAAY,KAAK,SAAS;AAAA,MAC1B,YAAY,KAAK,SAAS;AAAA,IAC9B;AAAA,EACJ;AAAA,EAEA,MAAM,IAAI,MAA8D;AACpE,QAAI;AACA,UAAI,UAAU,SAAS,EAAG,OAAM,MAAM,gBAAgB;AACtD,YAAM,KAAK,MAAM;AACjB,YAAM,MAAM,KAAK,sBAAsB,YAAY,sBAAsB,IAAI,CAAC;AAC9E,YAAM,SAAS,KAAK,kBAAkB;AACtC,cAAQ,IAAI,KAAK,QAAQ,SAAS,CAAC;AACnC,YAAM,KAAK,wBAAwB,GAAG;AACtC,aAAO,EAAE,GAAG,IAAI;AAAA,IACpB,SAAS,KAAK;AACV,aAAO,aAAa,GAAG;AAAA,IAC3B;AAAA,EACJ;AAAA,EAEA,MAAM,QAAQ,MAAkE;AAC5E,QAAI;AACA,UAAI,UAAU,SAAS,EAAG,OAAM,MAAM,gBAAgB;AACtD,YAAM,KAAK,MAAM;AACjB,YAAM,OAAO,YAAY,2BAA2B,IAAI,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAsB,GAAG,CAAC;AACtG,UAAI,SAAS,KAAK,kBAAkB;AAEpC,iBAAW,OAAO,MAAM;AACpB,gBAAQ,IAAI,KAAK,QAAQ,EAAE,MAAM;AAAA,MACrC;AAEA,YAAM,KAAK,mBAAmB;AAAA,QAC1B,GAAG,KAAK,SAAS;AAAA,QACjB,GAAG;AAAA,MACP,CAAC;AAED,aAAO,KAAK,WAAW,IAAI;AAAA,IAC/B,SAAS,KAAK;AACV,aAAO,aAAa,GAAG;AAAA,IAC3B;AAAA,EACJ;AAAA,EAEA,MAAM,QAAQ,SAA6E;AACvF,QAAI;AACA,UAAI,UAAU,SAAS,EAAG,OAAM,MAAM,gBAAgB;AACtD,YAAM,iBAAiB,MAAM,KAAK,mBAAmB;AACrD,YAAM,QAAQ,YAAY,sBAAsB,OAAO;AACvD,aAAO,KAAK,UAAU,gBAAgB,OAAO,QAAQ;AAAA,IACzD,SAAS,KAAK;AACV,aAAO,aAAa,GAAG;AAAA,IAC3B;AAAA,EACJ;AAAA,EAEA,MAAM,KAAQ,SAA6E;AACvF,QAAI;AACA,UAAI,UAAU,SAAS,EAAG,OAAM,MAAM,gBAAgB;AACtD,YAAM,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,mBAAmB,OAAO;AACjE,YAAM,iBAAiB,MAAM,KAAK,mBAAmB;AACrD,YAAM,SAAS,eAAe,OAAO,CAAC,QAAqB,MAAM,KAAK,QAAW,GAAG,CAAC;AACrF,aAAO,KAAK,UAAU,QAAQ,KAAK,QAAQ;AAAA,IAC/C,SAAS,KAAK;AACV,aAAO,aAAa,GAAG;AAAA,IAC3B;AAAA,EACJ;AAAA,EAEA,MAAM,OAAU,SAA+E;AAC3F,QAAI;AACA,UAAI,UAAU,SAAS,EAAG,OAAM,MAAM,gBAAgB;AACtD,YAAM,EAAE,OAAO,OAAO,IAAI,YAAY,qBAAqB,OAAO;AAClE,YAAM,aAAa,KAAK,sBAAsB,UAAU,CAAC,CAAC;AAC1D,YAAM,iBAAiB,MAAM,KAAK,mBAAmB;AACrD,YAAM,SAAS,CAAC;AAChB,iBAAW,OAAO,gBAAgB;AAC9B,YAAI,MAAM,KAAK,QAAW,GAAG,GAAG;AAC5B,iBAAO,OAAO,KAAK;AAAA,YACf,GAAG;AAAA,YACH,GAAG;AAAA,YACH,MAAM,IAAI;AAAA,UACd,CAAC;AACD,iBAAO,KAAK,EAAE,GAAG,IAAI,CAAC;AAAA,QAC1B;AAAA,MACJ;AACA,UAAI,OAAO,WAAW,EAAG,OAAM,MAAM,gBAAgB;AACrD,YAAM,KAAK,mBAAmB,cAAc;AAC5C,aAAO;AAAA,IACX,SAAS,KAAK;AACV,aAAO,aAAa,GAAG;AAAA,IAC3B;AAAA,EACJ;AAAA,EAEA,MAAM,OAAU,SAA4D;AACxE,QAAI;AACA,UAAI,UAAU,SAAS,EAAG,OAAM,MAAM,gBAAgB;AACtD,YAAM,EAAE,MAAM,IAAI,YAAY,qBAAqB,OAAO;AAC1D,YAAM,iBAAiB,MAAM,KAAK,mBAAmB;AACrD,YAAM,iBAAiB,eAAe,OAAO,CAAC,QAAqB,CAAC,MAAM,GAAG,CAAC;AAC9E,UAAI,eAAe,WAAW,eAAe,OAAQ;AACrD,YAAM,KAAK,mBAAmB,cAAc;AAAA,IAChD,SAAS,KAAK;AACV,aAAO,aAAa,GAAG;AAAA,IAC3B;AAAA,EACJ;AAAA,EAEA,MAAM,QAA+B;AACjC,QAAI;AACA,YAAM,KAAK,MAAM;AACjB,YAAM,KAAK,mBAAmB,CAAC,CAAC;AAAA,IACpC,SAAS,KAAK;AACV,aAAO,aAAa,GAAG;AAAA,IAC3B;AAAA,EACJ;AAAA,EAEA,MAAM,OAAsB;AACxB,UAAM,KAAK,SAAS,OAAO;AAAA,EAC/B;AACJ;;;AKvPO,IAAM,UAAN,MAAc;AAAA,EACV,OAAe;AAAA,EAEtB,YAAY,OAAmB;AAC3B,UAAM,EAAE,KAAK,IAAI,YAAY,kBAAkB,KAAK;AACpD,SAAK,OAAO;AAAA,EAChB;AAAA,EAEA,MAAM,iBAAiB,gBAA6C;AAChE,UAAM,OAAO,YAAY,sBAAsB,cAAc;AAC7D,UAAM,aAAa,IAAI,WAAW;AAAA,MAC9B;AAAA,MACA,MAAM,KAAK;AAAA,IACf,CAAC;AACD,WAAO,WAAW,KAAK;AAAA,EAC3B;AACJ;","names":["import_node_path","import_zod","z"]}

package/dist/index.d.mts

@@ -0,0 +1,84 @@
+type ZID = number;
+type CollectionProps = {
+    path: string;
+    name: string;
+};
+type CollectionContent = {
+    collection_name: string;
+    created_at: string;
+    updated_at: string;
+    data: Array<CollectionDataWithZID>;
+};
+type LegacyCollectionContent = Omit<CollectionContent, 'updated_at'> & {
+    updated_at?: string;
+    last_interaction?: string;
+};
+type CollectionData = Record<string, any>;
+type CollectionDataWithZID = {
+    [K in keyof CollectionData]: CollectionData[K];
+} & {
+    _zid?: ZID;
+};
+type KlauzProps = {
+    path: string;
+};
+type ErrorPayload = {
+    error: string;
+    code: string;
+};
+type Output<T> = T | ErrorPayload;
+type KzObject<T> = T & {
+    _zid: ZID;
+};
+type Callback<T> = (obj: T) => any;
+type FindOptions<T> = {
+    where: Callback<T>;
+    hideInfo?: Array<string>;
+};
+type FindOptionsWithoutWhere = Omit<FindOptions<any>, "where">;
+type UpdateOptions<T> = {
+    where: Callback<T>;
+    values?: CollectionData;
+};
+type DeleteOptions<T> = {
+    where: Callback<T>;
+};
+
+declare class Collection {
+    #private;
+    private readonly props;
+    constructor(props: CollectionProps);
+    init(): Promise<this>;
+    get information(): Promise<Omit<CollectionContent, 'data'>>;
+    add(data: CollectionData): Promise<Output<CollectionDataWithZID>>;
+    addMany(data: CollectionData[]): Promise<Output<CollectionDataWithZID[]>>;
+    findAll(options?: FindOptionsWithoutWhere): Promise<Output<CollectionDataWithZID[]>>;
+    find<T>(options: FindOptions<KzObject<T>>): Promise<Output<CollectionDataWithZID[]>>;
+    update<T>(options: UpdateOptions<KzObject<T>>): Promise<Output<CollectionDataWithZID[]>>;
+    delete<T>(options: DeleteOptions<KzObject<T>>): Promise<Output<void>>;
+    reset(): Promise<Output<void>>;
+    drop(): Promise<void>;
+}
+
+declare class KlauzDB {
+    path: string;
+    constructor(props: KlauzProps);
+    createCollection(collectionName: string): Promise<Collection>;
+}
+
+type KlauzErrorCode = 'KLAUZ_ERROR' | 'KLAUZ_VALIDATION_ERROR' | 'KLAUZ_STORAGE_ERROR' | 'KLAUZ_NOT_FOUND';
+declare class KlauzError extends Error {
+    readonly code: KlauzErrorCode;
+    constructor(message: string, code?: KlauzErrorCode, options?: ErrorOptions);
+}
+declare class KlauzValidationError extends KlauzError {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class KlauzStorageError extends KlauzError {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class KlauzNotFoundError extends KlauzError {
+    constructor(message: string, options?: ErrorOptions);
+}
+
+export { type Callback, type CollectionContent, type CollectionData, type CollectionDataWithZID, type CollectionProps, type DeleteOptions, type FindOptions, type FindOptionsWithoutWhere, KlauzDB, KlauzError, type KlauzErrorCode, KlauzNotFoundError, type KlauzProps, KlauzStorageError, KlauzValidationError, type KzObject, type LegacyCollectionContent, type Output, type UpdateOptions, type ZID };

package/dist/index.d.ts

@@ -0,0 +1,84 @@
+type ZID = number;
+type CollectionProps = {
+    path: string;
+    name: string;
+};
+type CollectionContent = {
+    collection_name: string;
+    created_at: string;
+    updated_at: string;
+    data: Array<CollectionDataWithZID>;
+};
+type LegacyCollectionContent = Omit<CollectionContent, 'updated_at'> & {
+    updated_at?: string;
+    last_interaction?: string;
+};
+type CollectionData = Record<string, any>;
+type CollectionDataWithZID = {
+    [K in keyof CollectionData]: CollectionData[K];
+} & {
+    _zid?: ZID;
+};
+type KlauzProps = {
+    path: string;
+};
+type ErrorPayload = {
+    error: string;
+    code: string;
+};
+type Output<T> = T | ErrorPayload;
+type KzObject<T> = T & {
+    _zid: ZID;
+};
+type Callback<T> = (obj: T) => any;
+type FindOptions<T> = {
+    where: Callback<T>;
+    hideInfo?: Array<string>;
+};
+type FindOptionsWithoutWhere = Omit<FindOptions<any>, "where">;
+type UpdateOptions<T> = {
+    where: Callback<T>;
+    values?: CollectionData;
+};
+type DeleteOptions<T> = {
+    where: Callback<T>;
+};
+
+declare class Collection {
+    #private;
+    private readonly props;
+    constructor(props: CollectionProps);
+    init(): Promise<this>;
+    get information(): Promise<Omit<CollectionContent, 'data'>>;
+    add(data: CollectionData): Promise<Output<CollectionDataWithZID>>;
+    addMany(data: CollectionData[]): Promise<Output<CollectionDataWithZID[]>>;
+    findAll(options?: FindOptionsWithoutWhere): Promise<Output<CollectionDataWithZID[]>>;
+    find<T>(options: FindOptions<KzObject<T>>): Promise<Output<CollectionDataWithZID[]>>;
+    update<T>(options: UpdateOptions<KzObject<T>>): Promise<Output<CollectionDataWithZID[]>>;
+    delete<T>(options: DeleteOptions<KzObject<T>>): Promise<Output<void>>;
+    reset(): Promise<Output<void>>;
+    drop(): Promise<void>;
+}
+
+declare class KlauzDB {
+    path: string;
+    constructor(props: KlauzProps);
+    createCollection(collectionName: string): Promise<Collection>;
+}
+
+type KlauzErrorCode = 'KLAUZ_ERROR' | 'KLAUZ_VALIDATION_ERROR' | 'KLAUZ_STORAGE_ERROR' | 'KLAUZ_NOT_FOUND';
+declare class KlauzError extends Error {
+    readonly code: KlauzErrorCode;
+    constructor(message: string, code?: KlauzErrorCode, options?: ErrorOptions);
+}
+declare class KlauzValidationError extends KlauzError {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class KlauzStorageError extends KlauzError {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class KlauzNotFoundError extends KlauzError {
+    constructor(message: string, options?: ErrorOptions);
+}
+
+export { type Callback, type CollectionContent, type CollectionData, type CollectionDataWithZID, type CollectionProps, type DeleteOptions, type FindOptions, type FindOptionsWithoutWhere, KlauzDB, KlauzError, type KlauzErrorCode, KlauzNotFoundError, type KlauzProps, KlauzStorageError, KlauzValidationError, type KzObject, type LegacyCollectionContent, type Output, type UpdateOptions, type ZID };