klauz-db 0.2.0

package/README.md

@@ -0,0 +1,533 @@
+<!-- # KlauzDB [![NPM version](https://img.shields.io/npm/v/klauz-db.svg?style=flat-square)](https://www.npmjs.com/package/klauz-db) -->
+# KlauzDB [![NPM version]]
+
+KlauzDB é um banco de dados orientado a collections projetado para oferecer uma solução leve e eficiente para a persistência de dados locais. Utilizando arquivos .json como seu meio de armazenamento, ele permite que desenvolvedores manipulem dados estruturados de maneira intuitiva e acessível.
+
+Com suporte a operações CRUD *(Criar, Ler, Atualizar e Deletar)*, o sistema permite a categorização de dados em coleções, facilitando a realização de consultas de forma ágil e adaptável. A estrutura em JSON garante que os dados sejam facilmente legíveis e interoperáveis com diversas linguagens de programação.
+
+Ideal para aplicações que exigem uma solução simples e eficaz de armazenamento, este banco de dados é perfeito para protótipos, projetos de pequeno a médio porte, testes automatizados e ambientes de desenvolvimento, proporcionando agilidade no gerenciamento de informações.
+<br>
+
+* [🌱 Instalação](#-Instalação)
+* [🏗️ Usabilidade](#%EF%B8%8F-Usabilidade)
+* [📖 Docs](#-Documentação)
+<!-- * [📚 Examples](#-examples) -->
+<!-- * [❓ FAQ](#-faq) -->
+<!-- * [⏱️ Changelog](./CHANGELOG.md) -->
+
+## 🌱 Instalação
+
+```bash
+# instalação local (recomendado)
+npm install klauz-db --save
+```
+
+Instalação via yarn: `yarn add klauz-db`
+
+## 🏗️ Usabilidade
+
+No começo da sua aplicação, importe o pacote "klauz-db" e defina o path principal para suas collections:
+
+```javascript
+const { KlauzDB } = require('klauz-db')
+
+const kz = new KlauzDB({
+    path: '{db_path}'
+})
+```
+
+ES6:
+
+```javascript
+import { KlauzDB } from 'klauz-db'
+
+const kz = new KlauzDB({
+    path: '{db_path}'
+})
+```
+
+Feito isso, você já pode criar suas Collections.
+<br>
+
+## 📖 Documentação
+
+KlauzDB expõe apenas uma função:
+
+* `createCollection`
+
+### createCollection()
+Habilita uma nova instância Collection, e cria seu arquivo .json para persistência dos dados.
+
+#### Syntax
+```js
+kz.createCollection(nomeCollection)
+```
+
+#### Parâmetros
+`nomeCollection: string`<br><br>Nome utilizado para criação de uma nova Collection e seu arquivo de persistência de dados;
+
+#### Retorno
+Instância própria da Collection, habilitando acesso as funções de banco de dados;
+
+#### Exemplo
+```js
+const kz = new KlauzDB({
+    path: './'
+})
+
+const collection = kz.createCollection('coll-teste')
+
+console.log(collection.information)
+// Resultado:
+    {
+        "collection_name": "coll-teste",
+        "created_at": "2024-08-25T22:41:57.416Z",
+        "last_interaction": "2024-08-25:41:57.416Z",
+    }
+//
+```
+
+Com sua collection criada agora você já tem acesso as seguintes funções de db:
+```js
+.add()
+.addMany()
+.update()
+.delete()
+.findAll()
+.find()
+.reset()
+```
+<br>
+
+### add
+Adiciona um novo objeto dentro da collection.
+
+#### Syntax
+```js
+collection.add(valor)
+```
+
+#### Parâmetros
+`valor: { key: value }` *(obrigatório)*<br><br>Objeto chave-valor utilizado para inserir um único registro dentro da Collection;
+
+#### Retorno
+Objeto adicionado já com as novas propriedades criadas pelo banco de dados;
+
+#### Exemplo
+```js
+const output = collection.add({
+    nome: 'User_1',
+    admin: true
+})
+
+console.log("output: ", output);
+// Resultado:
+    {
+        "nome": "User_1",
+        "admin": true
+        "_zid": 1
+    }
+//
+```
+<br>
+
+### addMany
+Adiciona um novo array de objetos dentro da collection.
+
+#### Syntax
+```js
+collection.addMany(valor)
+```
+
+#### Parâmetros
+`valor: [{ key: value }, { key: value }]` *(obrigatório)*<br><br>Array utilizado para inserir diversos registros dentro da Collection;
+
+#### Retorno
+Array de objetos adicionados já com as novas propriedades criadas pelo banco de dados;
+
+#### Exemplo
+```js
+const output = collection.addMany([
+    {
+        nome: 'User_1',
+        admin: true
+    },
+    {
+        nome: 'User_2',
+        admin: false
+    }
+])
+
+console.log("output: ", output);
+// Resultado:
+    [
+        {
+            "nome": "User_1",
+            "admin": true,
+            "_zid": 1
+        },
+        {
+            "nome": "User_2",
+            "admin": false,
+            "_zid": 2
+        }
+    ]
+//
+```
+<br>
+
+### findAll
+Retorna todos os dados contidos dentro da Collection.
+
+#### Syntax
+```js
+const optionsFindAll = {
+    hideInfo: Array<string>
+}
+collection.findAll(optionsFindAll?)
+```
+
+#### Parâmetros
+`optionsFindAll.hideInfo: Array<string>` *(opcional)*<br><br>Array contendo as informações que necessita esconder do retorno da função.<br><br>
+
+#### Retorno
+Todos os objetos persistidos na Collection;
+
+#### Exemplo
+```js
+// Adicionando dados
+collection.addMany([
+    {
+        nome: 'User_1',
+        admin: false
+    },
+    {
+        nome: 'User_2',
+        admin: false
+    }
+])
+
+
+// Consultando dados
+
+// Sem hideInfo
+const output1 = collection.findAll()
+
+console.log("output1", output1);
+// Resultado:
+    [
+        {
+            "nome": "User_1",
+            "admin": false,
+            "_zid": 1
+        },
+                {
+            "nome": "User_2",
+            "admin": false,
+            "_zid": 2
+        }
+    ]
+//
+
+
+// Com hideInfo
+const output2 = collection.findAll({
+    hideInfo: ['admin'] // Esconde as informações indicadas do retorno;
+})
+
+console.log("output2", output2);
+// Resultado:
+    [
+        {
+            "nome": "User_1",
+            "_zid": 1
+        },
+        {
+            "nome": "User_2",
+            "_zid": 2
+        }
+    ]
+//
+```
+<br>
+
+### find
+Retorna dados específicos que estão contidos na Collection.
+
+#### Syntax
+```js
+const optionsFind = {
+    where: (obj) => {},
+    hideInfo?: Array<string>
+}
+collection.find(optionsFind)
+```
+
+#### Parâmetros
+`optionsFind.where: function(obj) {}` *(obrigatório)*<br><br>Função callback que recebe como parâmetro os objetos contidos na Collection.<br>Seu retorno deve ser os objetos que serão consultados;<br><br>
+`optionsFind.hideInfo: Array<string>` *(opcional)*<br><br>Array contendo as informações que necessita esconder do retorno da função.<br><br>
+
+#### Retorno
+Objetos persistidos na Collection;
+
+#### Exemplo
+```js
+// Adicionando dados
+collection.addMany([
+    {
+        nome: 'User_1',
+        admin: true
+    },
+    {
+        nome: 'User_2',
+        admin: false
+    },
+        {
+        nome: 'User_3',
+        admin: false
+    }
+])
+
+
+// Consultando dados
+
+//Syntax Javascript antiga
+const antigo = collection.find({
+    where: function(obj) {
+        if (obj.admin === true) {
+            return obj
+        }
+    }
+})
+
+//Syntax Javascript moderna (recomendado)
+const moderno = collection.find({
+    where: obj => obj.admin === true
+})
+
+// Syntax Typescript:
+// Utiliza Generics para habilitar a tipagem dos objetos, incluindo a propriedade '_zid' como padrão.
+type User = { nome: string, admin: boolean };
+const typescript = collection.find<User>({
+    where: obj => obj.admin === true
+})
+
+console.log("antigo", antigo);
+console.log("moderno", moderno);
+console.log("typescript", typescript);
+// Resultado:
+    [
+        {
+            "nome": "User_1",
+            "admin": true,
+            "_zid": 1
+        }
+    ]
+//
+
+const output1 = collection.find({
+    where: obj => obj._zid > 2
+})
+
+console.log("output1", output1);
+// Resultado:
+    [
+        {
+            "nome": "User_3",
+            "admin": false,
+            "_zid": 3
+        }
+    ]
+//
+
+const output2 = collection.find({
+    where: obj => obj.admin === false,
+    hideInfo: ['admin', '_zid']
+})
+
+console.log("output2", output2);
+// Resultado:
+    [
+        {
+            "nome": "User_2",
+        },
+        {
+            "nome": "User_3",
+        }
+    ]
+//
+```
+<br>
+
+### update
+Altera um ou mais objetos dentro da Collection.
+
+#### Syntax
+```js
+const optionsUpdate = {
+    where: (obj) => {},
+    values: { key: value }
+}
+collection.update(optionsUpdate)
+```
+
+#### Parâmetros
+`optionsUpdate.where: function(obj) {}` *(obrigatório)*<br><br>Função callback que recebe como parâmetro os objetos contidos na Collection.<br>Seu retorno deve ser os objetos que serão atualizados;<br><br>
+`optionsUpdate.values: { key: value }` *(obrigatório)*<br><br>Objeto chave-valor com os novos valores a serem atualizados;
+
+#### Retorno
+Array de objetos já com as novas alterações;
+
+#### Exemplo
+```js
+// Adicionando dados
+collection.addMany([
+    {
+        nome: 'User_1',
+        admin: false
+    },
+    {
+        nome: 'User_2',
+        admin: false
+    }
+])
+
+
+// Alterando dados
+
+// JavaScript:
+const output1 = collection.update({
+    where: obj => obj.nome === 'User_1',
+    values: { admin: true }
+})
+
+
+// Typescript:
+type User = { nome: string, admin: boolean }
+const output2 = collection.update<User>({
+    where: (obj) => obj._zid === 1,
+    values: { admin: true }
+})
+
+
+console.log("output1: ", output1);
+console.log("output2: ", output2);
+// Resultado:
+    [
+        {
+            "nome": "User_1",
+            "admin": true,
+            "_zid": 1
+        }
+    ]
+//
+
+const output3 = collection.update({
+    where: obj => obj.nome === 'User_2',
+    values: { idade: 20 }
+})
+
+console.log("output3: ", output3);
+// Resultado:
+    [
+        {
+            "nome": "User_2",
+            "admin": false,
+            "idade": 20,
+            "_zid": 2
+        }
+    ]
+//
+```
+<br>
+
+### delete
+Remove um ou mais objetos da Collection.
+
+#### Syntax
+```js
+const optionsDelete = {
+    where: (obj) => {}
+}
+collection.delete(optionsDelete)
+```
+
+#### Parâmetros
+`optionsDelete.where: function(obj) {}` *(obrigatório)*<br><br>Função callback que recebe como parâmetro os objetos contidos na Collection.<br>Seu retorno deve ser os objetos que serão removidos;<br><br>
+
+#### Retorno
+Não possui retorno;
+
+#### Exemplo
+```js
+// Adicionando dados
+collection.addMany([
+    {
+        nome: 'User_1',
+        admin: false
+    },
+    {
+        nome: 'User_2',
+        admin: false
+    },
+    {
+        nome: 'User_3',
+        admin: false
+    }
+])
+
+
+// Deletando dados
+
+console.log("collection.findAll(): ", collection.findAll());
+// Consulta antes:
+    [
+        {
+            "nome": "User_1",
+            "admin": false,
+            "_zid": 1
+        },
+        {
+            "nome": "User_2",
+            "admin": false,
+            "_zid": 2
+        },
+        {
+            "nome": "User_3",
+            "admin": false,
+            "_zid": 3
+        }
+    ]
+//
+
+
+// JavaScript:
+collection.delete({
+    where: obj => obj.nome === 'User_1'
+})
+
+
+// Typescript:
+type User = { nome: string, admin: boolean };
+collection.delete<User>({
+    where: obj => obj._zid === 1
+})
+
+
+console.log("collection.findAll(): ", collection.findAll());
+// Consulta depois:
+    [
+        {
+            "nome": "User_2",
+            "admin": false,
+            "_zid": 2
+        },
+        {
+            "nome": "User_3",
+            "admin": false,
+            "_zid": 3
+        }
+    ]
+//
+```
+<br>

package/lib/Collection.d.ts

@@ -0,0 +1,15 @@
+import { CollectionContent, CollectionData, CollectionDataWithZID, CollectionProps, DeleteOptions, FindOptions, FindOptionsWithoutWhere, KzObject, Output, UpdateOptions } from "./Types";
+export declare class Collection {
+    #private;
+    private readonly props;
+    constructor(props: CollectionProps);
+    get information(): Omit<CollectionContent, 'data'>;
+    add(data: CollectionData): Output<CollectionDataWithZID>;
+    addMany(data: CollectionData[]): Output<CollectionDataWithZID[]>;
+    findAll(options?: FindOptionsWithoutWhere): Output<CollectionDataWithZID[]>;
+    find<T>(options: FindOptions<KzObject<T>>): Output<CollectionDataWithZID[]>;
+    update<T>(options: UpdateOptions<KzObject<T>>): Output<CollectionDataWithZID[]>;
+    delete<T>(options: DeleteOptions<KzObject<T>>): Output<void>;
+    reset(): Output<void>;
+    drop(): void;
+}

package/lib/Collection.js

@@ -0,0 +1,242 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Collection = void 0;
+const fs_1 = require("fs");
+const zod_1 = __importDefault(require("zod"));
+const Error_1 = require("./Error.js");
+class Collection {
+    props;
+    #name;
+    #path;
+    #content = {};
+    constructor(props) {
+        this.props = props;
+        const fileExtension = '.json';
+        const { path, name } = props;
+        this.#name = name;
+        this.#path = `${path}/.${name}${fileExtension}`;
+        this.#load();
+    }
+    #load() {
+        try {
+            (0, fs_1.accessSync)(this.#path, fs_1.constants.F_OK);
+            const readedContent = (0, fs_1.readFileSync)(this.#path, {
+                encoding: 'utf-8'
+            });
+            this.#content = JSON.parse(readedContent);
+        }
+        catch (err) {
+            const content = {
+                collection_name: this.#name,
+                created_at: new Date().toISOString(),
+                last_interaction: new Date().toISOString(),
+                data: []
+            };
+            this.#content = content;
+        }
+        finally {
+            this.#save(this.#content);
+        }
+    }
+    #save(content) {
+        (0, fs_1.writeFileSync)(this.#path, JSON.stringify(content, null, 2));
+    }
+    #setCollectionDataValue(data) {
+        this.#load();
+        this.#content.last_interaction = new Date().toISOString();
+        this.#content.data.push(data);
+        this.#save(this.#content);
+    }
+    #setCollectionData(data) {
+        this.#load();
+        this.#content.last_interaction = new Date().toISOString();
+        this.#content.data = data;
+        this.#save(this.#content);
+    }
+    #getCollectionData() {
+        this.#load();
+        return this.#content.data;
+    }
+    #getLastNumericId() {
+        this.#load();
+        const lastObject = this.#content.data.findLast((obj) => typeof obj._zid === 'number');
+        return lastObject?._zid ?? 0;
+    }
+    get information() {
+        this.#load();
+        return {
+            collection_name: this.#content.collection_name,
+            created_at: this.#content.created_at,
+            last_interaction: this.#content.last_interaction,
+        };
+    }
+    add(data) {
+        try {
+            if (arguments.length > 1)
+                throw TypeError('Invalid params');
+            const schema = zod_1.default.record(zod_1.default.string(), zod_1.default.any(), { message: `Content must be a object. Use 'addMany' method, to insert a new array` });
+            const obj = schema.parse(data);
+            const lastId = this.#getLastNumericId();
+            Reflect.set(obj, '_zid', lastId + 1);
+            this.#setCollectionDataValue(obj);
+            return obj;
+        }
+        catch (err) {
+            return (0, Error_1.errorMessage)(err);
+        }
+    }
+    addMany(data) {
+        try {
+            if (arguments.length > 1)
+                throw TypeError('Invalid params');
+            const schemaArray = zod_1.default.array(zod_1.default.record(zod_1.default.string(), zod_1.default.any()));
+            const schemaObject = zod_1.default.record(zod_1.default.string(), zod_1.default.any());
+            const objs = schemaArray.parse(data);
+            for (const obj of objs) {
+                schemaObject.parse(obj);
+                const lastId = this.#getLastNumericId();
+                Reflect.set(obj, '_zid', lastId + 1);
+                this.#setCollectionDataValue(obj);
+            }
+            return objs;
+        }
+        catch (err) {
+            return (0, Error_1.errorMessage)(err);
+        }
+    }
+    findAll(options) {
+        try {
+            if (arguments.length > 1)
+                throw TypeError('Invalid params');
+            const collectionData = this.#getCollectionData();
+            const optionsSchema = zod_1.default.object({
+                hideInfo: zod_1.default.array(zod_1.default.string()).optional(),
+            }).optional();
+            const zOpts = optionsSchema.parse(options);
+            if (zOpts && Object.values(zOpts).length > 0) {
+                const keys = Object.keys(zOpts);
+                for (const key of keys) {
+                    if (!zOpts[key])
+                        continue;
+                    switch (key) {
+                        case 'hideInfo':
+                            const infos = zOpts.hideInfo;
+                            infos.forEach((info) => {
+                                for (const obj of collectionData) {
+                                    if (!Reflect.has(obj, info))
+                                        continue;
+                                    Reflect.deleteProperty(obj, info);
+                                }
+                            });
+                            break;
+                    }
+                }
+            }
+            return collectionData;
+        }
+        catch (err) {
+            return (0, Error_1.errorMessage)(err);
+        }
+    }
+    find(options) {
+        try {
+            if (arguments.length > 1)
+                throw TypeError('Invalid params');
+            const optionsSchema = zod_1.default.object({
+                where: zod_1.default.function(),
+                hideInfo: zod_1.default.array(zod_1.default.string()).optional(),
+            });
+            const { where, ...opts } = optionsSchema.parse(options);
+            const collectionData = this.#getCollectionData();
+            const output = [];
+            for (const obj of collectionData) {
+                if (where.call(undefined, obj)) {
+                    if (opts && Object.values(opts).length > 0) {
+                        const keys = Object.keys(opts);
+                        for (const key of keys) {
+                            switch (key) {
+                                case 'hideInfo':
+                                    const infos = opts.hideInfo;
+                                    infos.forEach((info) => Reflect.deleteProperty(obj, info));
+                                    break;
+                            }
+                        }
+                    }
+                    output.push(obj);
+                }
+            }
+            return output;
+        }
+        catch (err) {
+            return (0, Error_1.errorMessage)(err);
+        }
+    }
+    update(options) {
+        try {
+            if (arguments.length > 1)
+                throw TypeError('Invalid params');
+            const optionsSchema = zod_1.default.object({
+                where: zod_1.default.function(),
+                values: zod_1.default.record(zod_1.default.string(), zod_1.default.any()),
+            });
+            const { where, values } = optionsSchema.parse(options);
+            const collectionData = this.#getCollectionData();
+            const output = [];
+            for (const obj of collectionData) {
+                if (where.call(undefined, obj)) {
+                    const tempId = obj._zid;
+                    Reflect.deleteProperty(obj, '_zid');
+                    Object.assign(obj, {
+                        ...obj,
+                        ...values,
+                        _zid: tempId
+                    });
+                    output.push(obj);
+                }
+            }
+            if (output.length === 0)
+                throw Error('Data not found');
+            this.#setCollectionData(collectionData);
+            return output;
+        }
+        catch (err) {
+            return (0, Error_1.errorMessage)(err);
+        }
+    }
+    delete(options) {
+        try {
+            if (arguments.length > 1)
+                throw TypeError('Invalid params');
+            const optionsSchema = zod_1.default.object({
+                where: zod_1.default.function(),
+            });
+            const { where } = optionsSchema.parse(options);
+            const collectionData = this.#getCollectionData();
+            const dataPostDelete = collectionData.filter((obj) => !where(obj));
+            if (collectionData.length === dataPostDelete.length)
+                return;
+            this.#setCollectionData(dataPostDelete);
+        }
+        catch (err) {
+            return (0, Error_1.errorMessage)(err);
+        }
+    }
+    reset() {
+        try {
+            this.#load();
+            const arr = [];
+            this.#setCollectionData(arr);
+        }
+        catch (err) {
+            return (0, Error_1.errorMessage)(err);
+        }
+    }
+    drop() {
+        (0, fs_1.unlinkSync)(this.#path);
+    }
+}
+exports.Collection = Collection;
+//# sourceMappingURL=Collection.js.map

package/lib/Collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Collection.js","sourceRoot":"","sources":["../src/Collection.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAoF;AACpF,8CAAoB;AACpB,mCAAuC;AAevC,MAAa,UAAU;IAKU;IAJpB,KAAK,CAAQ;IACb,KAAK,CAAQ;IACtB,QAAQ,GAAG,EAAuB,CAAA;IAElC,YAA6B,KAAsB;QAAtB,UAAK,GAAL,KAAK,CAAiB;QAC/C,MAAM,aAAa,GAAG,OAAO,CAAA;QAC7B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;QAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,KAAK,GAAG,GAAG,IAAI,KAAK,IAAI,GAAG,aAAa,EAAE,CAAA;QAC/C,IAAI,CAAC,KAAK,EAAE,CAAA;IAChB,CAAC;IAED,KAAK;QACD,IAAI,CAAC;YACD,IAAA,eAAU,EAAC,IAAI,CAAC,KAAK,EAAE,cAAS,CAAC,IAAI,CAAC,CAAA;YACtC,MAAM,aAAa,GAAG,IAAA,iBAAY,EAAC,IAAI,CAAC,KAAK,EAAE;gBAC3C,QAAQ,EAAE,OAAO;aACpB,CAAC,CAAA;YACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;QAC7C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,OAAO,GAAsB;gBAC/B,eAAe,EAAE,IAAI,CAAC,KAAK;gBAC3B,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACpC,gBAAgB,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBAC1C,IAAI,EAAE,EAAE;aACX,CAAA;YACD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QAC3B,CAAC;gBAAS,CAAC;YACP,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAA0B;QAC5B,IAAA,kBAAa,EAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED,uBAAuB,CAAC,IAA2B;QAC/C,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,IAAI,CAAC,QAAQ,CAAC,gBAAgB,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;QACzD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7B,CAAC;IAED,kBAAkB,CAAC,IAA6B;QAC5C,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,IAAI,CAAC,QAAQ,CAAC,gBAAgB,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;QACzD,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAA;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7B,CAAC;IAED,kBAAkB;QACd,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAA;IAC7B,CAAC;IAED,iBAAiB;QACb,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAA0B,EAAE,EAAE,CAAC,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;QAC5G,OAAO,UAAU,EAAE,IAAI,IAAI,CAAC,CAAA;IAChC,CAAC;IAED,IAAI,WAAW;QACX,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,OAAO;YACH,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe;YAC9C,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU;YACpC,gBAAgB,EAAE,IAAI,CAAC,QAAQ,CAAC,gBAAgB;SACnD,CAAA;IACL,CAAC;IAED,GAAG,CAAC,IAAoB;QACpB,IAAI,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,SAAS,CAAC,gBAAgB,CAAC,CAAA;YAC3D,MAAM,MAAM,GAAG,aAAC,CAAC,MAAM,CAAC,aAAC,CAAC,MAAM,EAAE,EAAE,aAAC,CAAC,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,uEAAuE,EAAE,CAAC,CAAA;YAClI,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAA0B,CAAA;YACvD,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;YACvC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,CAAA;YACpC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAA;YACjC,OAAO,GAAG,CAAA;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,OAAO,CAAC,IAAsB;QAC1B,IAAI,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,SAAS,CAAC,gBAAgB,CAAC,CAAA;YAC3D,MAAM,WAAW,GAAG,aAAC,CAAC,KAAK,CAAC,aAAC,CAAC,MAAM,CAAC,aAAC,CAAC,MAAM,EAAE,EAAE,aAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YAC1D,MAAM,YAAY,GAAG,aAAC,CAAC,MAAM,CAAC,aAAC,CAAC,MAAM,EAAE,EAAE,aAAC,CAAC,GAAG,EAAE,CAAC,CAAA;YAClD,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAA4B,CAAA;YAC/D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACvB,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;gBACvC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,CAAA;gBACpC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAA;YACrC,CAAC;YACD,OAAO,IAAI,CAAA;QACf,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,OAAO,CAAC,OAAiC;QACrC,IAAI,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,SAAS,CAAC,gBAAgB,CAAC,CAAA;YAC3D,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAA;YAChD,MAAM,aAAa,GAAG,aAAC,CAAC,MAAM,CAAC;gBAC3B,QAAQ,EAAE,aAAC,CAAC,KAAK,CAAC,aAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;aAC3C,CAAC,CAAC,QAAQ,EAAE,CAAA;YACb,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAA4B,CAAA;YACrE,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAyC,CAAA;gBACvE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACrB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;wBAAE,SAAQ;oBACzB,QAAQ,GAAG,EAAE,CAAC;wBACV,KAAK,UAAU;4BACX,MAAM,KAAK,GAAG,KAAK,CAAC,QAA4D,CAAA;4BAChF,KAAK,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE;gCAC3B,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;oCAC/B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC;wCAAE,SAAQ;oCACrC,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;gCACrC,CAAC;4BACL,CAAC,CAAC,CAAA;4BACN,MAAM;oBACV,CAAC;gBACL,CAAC;YACL,CAAC;YACD,OAAO,cAAc,CAAA;QACzB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,IAAI,CAAI,OAAiC;QACrC,IAAI,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,SAAS,CAAC,gBAAgB,CAAC,CAAA;YAC3D,MAAM,aAAa,GAAG,aAAC,CAAC,MAAM,CAAC;gBAC3B,KAAK,EAAE,aAAC,CAAC,QAAQ,EAAE;gBACnB,QAAQ,EAAE,aAAC,CAAC,KAAK,CAAC,aAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;aAC3C,CAAC,CAAA;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAmB,CAAA;YACzE,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAS,CAAA;YACvD,MAAM,MAAM,GAAG,EAA6B,CAAA;YAC5C,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;gBAC/B,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC;oBAC7B,IAAI,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACzC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAgC,CAAA;wBAC7D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;4BACrB,QAAQ,GAAG,EAAE,CAAC;gCACV,KAAK,UAAU;oCACX,MAAM,KAAK,GAAG,IAAI,CAAC,QAAmD,CAAA;oCACtE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;oCACtE,MAAM;4BACV,CAAC;wBACL,CAAC;oBACL,CAAC;oBACD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBACpB,CAAC;YACL,CAAC;YACD,OAAO,MAAM,CAAA;QACjB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,MAAM,CAAI,OAAmC;QACzC,IAAI,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,SAAS,CAAC,gBAAgB,CAAC,CAAA;YAC3D,MAAM,aAAa,GAAG,aAAC,CAAC,MAAM,CAAC;gBAC3B,KAAK,EAAE,aAAC,CAAC,QAAQ,EAAE;gBACnB,MAAM,EAAE,aAAC,CAAC,MAAM,CAAC,aAAC,CAAC,MAAM,EAAE,EAAE,aAAC,CAAC,GAAG,EAAE,CAAC;aACxC,CAAC,CAAA;YACF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAqB,CAAA;YAC1E,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAS,CAAA;YACvD,MAAM,MAAM,GAAG,EAA6B,CAAA;YAC5C,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;gBAC/B,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC;oBAC7B,MAAM,MAAM,GAAG,GAAG,CAAC,IAAW,CAAA;oBAC9B,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;oBACnC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;wBACf,GAAG,GAAG;wBACN,GAAG,MAAM;wBACT,IAAI,EAAE,MAAM;qBACf,CAAC,CAAA;oBACF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBACpB,CAAC;YACL,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM,KAAK,CAAC,gBAAgB,CAAC,CAAA;YACtD,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAA;YACvC,OAAO,MAAM,CAAA;QACjB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,MAAM,CAAI,OAAmC;QACzC,IAAI,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,SAAS,CAAC,gBAAgB,CAAC,CAAA;YAC3D,MAAM,aAAa,GAAG,aAAC,CAAC,MAAM,CAAC;gBAC3B,KAAK,EAAE,aAAC,CAAC,QAAQ,EAAE;aACtB,CAAC,CAAA;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAqB,CAAA;YAClE,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAS,CAAA;YACvD,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,GAAgB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAA4B,CAAA;YAC1G,IAAI,cAAc,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM;gBAAE,OAAM;YAC3D,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAA;QAC3C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,KAAK;QACD,IAAI,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,CAAA;YACZ,MAAM,GAAG,GAAG,EAA6B,CAAA;YACzC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAA;QAChC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,IAAI;QACA,IAAA,eAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC1B,CAAC;CACJ;AAjOD,gCAiOC"}

package/lib/Error.d.ts

@@ -0,0 +1,3 @@
+export declare function errorMessage(err: any): {
+    error: any;
+};

package/lib/Error.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorMessage = errorMessage;
+const zod_1 = require("zod");
+function errorMessage(err) {
+    if (err instanceof zod_1.ZodError) {
+        const error = err.errors.at(-1);
+        return {
+            error: error?.message
+        };
+    }
+    else {
+        return {
+            error: err.message
+        };
+    }
+}
+//# sourceMappingURL=Error.js.map

package/lib/Error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["../src/Error.ts"],"names":[],"mappings":";;AAEA,oCAWC;AAbD,6BAA8B;AAE9B,SAAgB,YAAY,CAAC,GAAQ;IACjC,IAAI,GAAG,YAAY,cAAQ,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/B,OAAO;YACH,KAAK,EAAE,KAAK,EAAE,OAAO;SACxB,CAAA;IACL,CAAC;SAAM,CAAC;QACJ,OAAO;YACH,KAAK,EAAE,GAAG,CAAC,OAAO;SACrB,CAAA;IACL,CAAC;AACL,CAAC"}

package/lib/Klauz.d.ts

@@ -0,0 +1,7 @@
+import { Collection } from "./Collection";
+import { KlauzProps } from "./Types";
+export declare class KlauzDB {
+    path: string;
+    constructor(props: KlauzProps);
+    createCollection(collectionName: string): Collection;
+}

package/lib/Klauz.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KlauzDB = void 0;
+const zod_1 = __importDefault(require("zod"));
+const Collection_1 = require("./Collection.js");
+class KlauzDB {
+    path = '';
+    constructor(props) {
+        const schema = zod_1.default.object({
+            path: zod_1.default.string().min(1)
+        });
+        const { path } = schema.parse(props);
+        this.path = path;
+    }
+    createCollection(collectionName) {
+        const schema = zod_1.default.string().min(1);
+        const name = schema.parse(collectionName);
+        const collection = new Collection_1.Collection({
+            name,
+            path: this.path
+        });
+        return collection;
+    }
+}
+exports.KlauzDB = KlauzDB;
+//# sourceMappingURL=Klauz.js.map

package/lib/Klauz.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Klauz.js","sourceRoot":"","sources":["../src/Klauz.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAoB;AACpB,6CAA0C;AAG1C,MAAa,OAAO;IACT,IAAI,GAAW,EAAE,CAAA;IAExB,YAAY,KAAiB;QACzB,MAAM,MAAM,GAAG,aAAC,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;SAC1B,CAAC,CAAA;QACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IACpB,CAAC;IAED,gBAAgB,CAAC,cAAsB;QACnC,MAAM,MAAM,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QACzC,MAAM,UAAU,GAAG,IAAI,uBAAU,CAAC;YAC9B,IAAI;YACJ,IAAI,EAAE,IAAI,CAAC,IAAI;SAClB,CAAC,CAAA;QACF,OAAO,UAAU,CAAA;IACrB,CAAC;CACJ;AApBD,0BAoBC"}

package/lib/Types.d.ts

@@ -0,0 +1,41 @@
+export type ZID = number;
+export type CollectionProps = {
+    path: string;
+    name: string;
+};
+export type CollectionContent = {
+    collection_name: string;
+    created_at: string;
+    last_interaction: string;
+    data: Array<CollectionDataWithZID>;
+};
+export type CollectionData = Record<string, any>;
+export type CollectionDataWithZID = {
+    [K in keyof CollectionData]: CollectionData[K];
+} & {
+    _zid?: ZID;
+};
+export type KlauzProps = {
+    path: string;
+};
+type ErrorPayload = {
+    error: string;
+};
+export type Output<T> = T | ErrorPayload;
+export type KzObject<T> = T & {
+    _zid: ZID;
+};
+export type Callback<T> = (obj: T) => any;
+export type FindOptions<T> = {
+    where: Callback<T>;
+    hideInfo?: Array<string>;
+};
+export type FindOptionsWithoutWhere = Omit<FindOptions<any>, "where">;
+export type UpdateOptions<T> = {
+    where: Callback<T>;
+    values?: CollectionData;
+};
+export type DeleteOptions<T> = {
+    where: Callback<T>;
+};
+export {};

package/lib/Types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Types.js.map

package/lib/Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Types.js","sourceRoot":"","sources":["../src/Types.ts"],"names":[],"mappings":""}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Klauz';
+export * from './Types';

package/lib/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Klauz.js"), exports);
+__exportStar(require("./Types.js"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,0CAAuB"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "klauz-db",
+  "version": "0.2.0",
+  "description": "Um banco de dados simples, para aplicações com um grau menor de complexidade",
+  "main": "lib/index.js",
+  "scripts": {
+    "dev": "tsx watch --env-file .env src/client",
+    "build": "tsc",
+    "test-errors": "tsx --env-file .env tests/test-errors.ts",
+    "test": "jest && npm run test-errors",
+    "prepublish": "npm run test && npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vnikolaus/KlauzDB.git"
+  },
+  "author": "Victor Nikolaus",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/vnikolaus/KlauzDB/issues"
+  },
+  "homepage": "https://github.com/vnikolaus/KlauzDB#readme",
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "setupFiles": [
+      "dotenv/config"
+    ],
+    "coveragePathIgnorePatterns": [
+      "/node_modules/",
+      "lib"
+    ]
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "devDependencies": {
+    "@types/jest": "29.5.12",
+    "@types/node": "20.14.11",
+    "jest": "29.7.0",
+    "ts-jest": "29.2.3",
+    "tsx": "4.16.2",
+    "typescript": "5.5.3"
+  },
+  "dependencies": {
+    "dotenv": "^16.4.5",
+    "zod": "3.23.8"
+  }
+}