From aaceb2e6889e5a0fdd86c00dda90e12dab05404b Mon Sep 17 00:00:00 2001 From: James Pearce Date: Sun, 16 Jan 2022 18:15:00 -0800 Subject: [PATCH] v1.0.1 .d.ts can now be found when importing from default module --- docs/index.html | 2 +- package-lock.json | 133 +++++++++------------------------------------- package.json | 7 +-- readme.md | 2 +- 4 files changed, 32 insertions(+), 112 deletions(-) diff --git a/docs/index.html b/docs/index.html index 196990510b3..1831e735206 100644 --- a/docs/index.html +++ b/docs/index.html @@ -142,4 +142,4 @@ checkpoints.goBackward(); console.log(store.getCell('pets', 'felix', 'sold')); // -> false -

Did we say tiny?

If you use the basic store module alone, you'll only add a gzipped 2.6kB to your app. You can incrementally add the other modules as you need more functionality, or get it all for 5.5kB. The ui-react adaptor is just another 2.6kB, and everything is fast.

Life's easy when you have zero dependencies.

Read more about how TinyBase is structured in the Architecture guide.

 .js.gz.jsdebug.js.d.ts
store2.6kB5.8kB23.8kB86.9kB
indexes1.5kB2.9kB13.0kB27.4kB
metrics1.5kB3.0kB12.3kB26.6kB
relationships1.5kB3.1kB14.3kB39.0kB
checkpoints1.3kB2.4kB10.0kB30.7kB
persisters0.8kB1.6kB4.9kB26.7kB
common0.1kB0.1kB0.1kB3.5kB
tinybase5.5kB13.0kB53.9kB0.3kB

Well tested and documented.

TinyBase has 100.0% test coverage, including the code throughout the documentation - even on this page! The guides, demos, and API examples are designed to make it as easy as possible to get up and running.

Read more about how TinyBase is tested in the Unit Testing guide.

 TotalTestedCoverage
Lines933933100.0%
Statements1,0181,018100.0%
Functions366366100.0%
Branches341341100.0%
Tests1,712
Assertions7,959

Get started

Try the demos

Read the docs


Follow

About

Building TinyBase was an interesting exercise in API design, minification, and documentation. It's not my day job, but I do intend to maintain it, so please provide feedback. I could not have done this without these great projects and friends, and I hope you enjoy using it!

\ No newline at end of file +

Did we say tiny?

If you use the basic store module alone, you'll only add a gzipped 2.6kB to your app. You can incrementally add the other modules as you need more functionality, or get it all for 5.5kB. The ui-react adaptor is just another 2.6kB, and everything is fast.

Life's easy when you have zero dependencies.

Read more about how TinyBase is structured in the Architecture guide.

 .js.gz.jsdebug.js.d.ts
store2.6kB5.8kB23.8kB86.9kB
indexes1.5kB2.9kB13.0kB27.4kB
metrics1.5kB3.0kB12.3kB26.6kB
relationships1.5kB3.1kB14.3kB39.0kB
checkpoints1.3kB2.4kB10.0kB30.7kB
persisters0.8kB1.6kB4.9kB26.7kB
common0.1kB0.1kB0.1kB3.5kB
tinybase5.5kB13.0kB53.9kB0.3kB

Well tested and documented.

TinyBase has 100.0% test coverage, including the code throughout the documentation - even on this page! The guides, demos, and API examples are designed to make it as easy as possible to get up and running.

Read more about how TinyBase is tested in the Unit Testing guide.

 TotalTestedCoverage
Lines933933100.0%
Statements1,0181,018100.0%
Functions366366100.0%
Branches341341100.0%
Tests1,712
Assertions7,959

Get started

Try the demos

Read the docs


Follow

About

Building TinyBase was an interesting exercise in API design, minification, and documentation. It's not my day job, but I do intend to maintain it, so please provide feedback. I could not have done this without these great projects and friends, and I hope you enjoy using it!

\ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 7e032abec28..08fc1ead31c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { "name": "tinybase", - "version": "1.0.0", + "version": "1.0.1", "lockfileVersion": 2, "requires": true, "packages": { "": { - "version": "1.0.0", + "version": "1.0.1", "license": "MIT", "devDependencies": { "@babel/cli": "^7.16.8", @@ -34,9 +34,9 @@ "country-flag-emoji-json": "^2.0.0", "cspell": "^5.15.2", "esbuild": "^0.14.11", - "eslint": "^8.6.0", + "eslint": "^8.7.0", "eslint-config-prettier": "^8.3.0", - "eslint-plugin-jest": "^25.3.4", + "eslint-plugin-jest": "^25.7.0", "eslint-plugin-jsdoc": "^37.6.1", "eslint-plugin-react": "^7.28.0", "eslint-plugin-react-hooks": "^4.3.0", @@ -4124,15 +4124,6 @@ "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/ansi-colors": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", - "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/ansi-escapes": { "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", @@ -6698,18 +6689,6 @@ "once": "^1.4.0" } }, - "node_modules/enquirer": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", - "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", - "dev": true, - "dependencies": { - "ansi-colors": "^4.1.1" - }, - "engines": { - "node": ">=8.6" - } - }, "node_modules/errno": { "version": "0.1.8", "resolved": "https://registry.npmjs.org/errno/-/errno-0.1.8.tgz", @@ -7199,9 +7178,9 @@ } }, "node_modules/eslint": { - "version": "8.6.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.6.0.tgz", - "integrity": "sha512-UvxdOJ7mXFlw7iuHZA4jmzPaUqIw54mZrv+XPYKNbKdLR0et4rf60lIZUU9kiNtnzzMzGWxMV+tQ7uG7JG8DPw==", + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.7.0.tgz", + "integrity": "sha512-ifHYzkBGrzS2iDU7KjhCAVMGCvF6M3Xfs8X8b37cgrUlDt6bWRTpRh6T/gtSXv1HJ/BUGgmjvNvOEGu85Iif7w==", "dev": true, "dependencies": { "@eslint/eslintrc": "^1.0.5", @@ -7211,11 +7190,10 @@ "cross-spawn": "^7.0.2", "debug": "^4.3.2", "doctrine": "^3.0.0", - "enquirer": "^2.3.5", "escape-string-regexp": "^4.0.0", "eslint-scope": "^7.1.0", "eslint-utils": "^3.0.0", - "eslint-visitor-keys": "^3.1.0", + "eslint-visitor-keys": "^3.2.0", "espree": "^9.3.0", "esquery": "^1.4.0", "esutils": "^2.0.2", @@ -7224,7 +7202,7 @@ "functional-red-black-tree": "^1.0.1", "glob-parent": "^6.0.1", "globals": "^13.6.0", - "ignore": "^4.0.6", + "ignore": "^5.2.0", "import-fresh": "^3.0.0", "imurmurhash": "^0.1.4", "is-glob": "^4.0.0", @@ -7235,9 +7213,7 @@ "minimatch": "^3.0.4", "natural-compare": "^1.4.0", "optionator": "^0.9.1", - "progress": "^2.0.0", "regexpp": "^3.2.0", - "semver": "^7.2.1", "strip-ansi": "^6.0.1", "strip-json-comments": "^3.1.0", "text-table": "^0.2.0", @@ -7266,9 +7242,9 @@ } }, "node_modules/eslint-plugin-jest": { - "version": "25.3.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-25.3.4.tgz", - "integrity": "sha512-CCnwG71wvabmwq/qkz0HWIqBHQxw6pXB1uqt24dxqJ9WB34pVg49bL1sjXphlJHgTMWGhBjN1PicdyxDxrfP5A==", + "version": "25.7.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-25.7.0.tgz", + "integrity": "sha512-PWLUEXeeF7C9QGKqvdSbzLOiLTx+bno7/HC9eefePfEb257QFHg7ye3dh80AZVkaa/RQsBB1Q/ORQvg2X7F0NQ==", "dev": true, "dependencies": { "@typescript-eslint/experimental-utils": "^5.0.0" @@ -7453,9 +7429,9 @@ } }, "node_modules/eslint-visitor-keys": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.1.0.tgz", - "integrity": "sha512-yWJFpu4DtjsWKkt5GeNBBuZMlNcYVs6vRCLoCVEJrTjaSB6LC98gFipNK/erM2Heg/E8mIK+hXG/pJMLK+eRZA==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.2.0.tgz", + "integrity": "sha512-IOzT0X126zn7ALX0dwFiUQEdsfzrm4+ISsQS8nukaJXwEyYKRSnEIIDULYg1mCtGp7UUXgfGl7BIolXREQK+XQ==", "dev": true, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" @@ -7577,15 +7553,6 @@ "node": ">=8" } }, - "node_modules/eslint/node_modules/ignore": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", - "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", - "dev": true, - "engines": { - "node": ">= 4" - } - }, "node_modules/eslint/node_modules/js-yaml": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", @@ -7598,21 +7565,6 @@ "js-yaml": "bin/js-yaml.js" } }, - "node_modules/eslint/node_modules/semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", - "dev": true, - "dependencies": { - "lru-cache": "^6.0.0" - }, - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/eslint/node_modules/supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -23300,12 +23252,6 @@ "uri-js": "^4.2.2" } }, - "ansi-colors": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", - "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", - "dev": true - }, "ansi-escapes": { "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", @@ -25331,15 +25277,6 @@ "once": "^1.4.0" } }, - "enquirer": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", - "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", - "dev": true, - "requires": { - "ansi-colors": "^4.1.1" - } - }, "errno": { "version": "0.1.8", "resolved": "https://registry.npmjs.org/errno/-/errno-0.1.8.tgz", @@ -25674,9 +25611,9 @@ } }, "eslint": { - "version": "8.6.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.6.0.tgz", - "integrity": "sha512-UvxdOJ7mXFlw7iuHZA4jmzPaUqIw54mZrv+XPYKNbKdLR0et4rf60lIZUU9kiNtnzzMzGWxMV+tQ7uG7JG8DPw==", + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.7.0.tgz", + "integrity": "sha512-ifHYzkBGrzS2iDU7KjhCAVMGCvF6M3Xfs8X8b37cgrUlDt6bWRTpRh6T/gtSXv1HJ/BUGgmjvNvOEGu85Iif7w==", "dev": true, "requires": { "@eslint/eslintrc": "^1.0.5", @@ -25686,11 +25623,10 @@ "cross-spawn": "^7.0.2", "debug": "^4.3.2", "doctrine": "^3.0.0", - "enquirer": "^2.3.5", "escape-string-regexp": "^4.0.0", "eslint-scope": "^7.1.0", "eslint-utils": "^3.0.0", - "eslint-visitor-keys": "^3.1.0", + "eslint-visitor-keys": "^3.2.0", "espree": "^9.3.0", "esquery": "^1.4.0", "esutils": "^2.0.2", @@ -25699,7 +25635,7 @@ "functional-red-black-tree": "^1.0.1", "glob-parent": "^6.0.1", "globals": "^13.6.0", - "ignore": "^4.0.6", + "ignore": "^5.2.0", "import-fresh": "^3.0.0", "imurmurhash": "^0.1.4", "is-glob": "^4.0.0", @@ -25710,9 +25646,7 @@ "minimatch": "^3.0.4", "natural-compare": "^1.4.0", "optionator": "^0.9.1", - "progress": "^2.0.0", "regexpp": "^3.2.0", - "semver": "^7.2.1", "strip-ansi": "^6.0.1", "strip-json-comments": "^3.1.0", "text-table": "^0.2.0", @@ -25799,12 +25733,6 @@ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true }, - "ignore": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", - "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", - "dev": true - }, "js-yaml": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", @@ -25814,15 +25742,6 @@ "argparse": "^2.0.1" } }, - "semver": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", - "dev": true, - "requires": { - "lru-cache": "^6.0.0" - } - }, "supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -25848,9 +25767,9 @@ "requires": {} }, "eslint-plugin-jest": { - "version": "25.3.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-25.3.4.tgz", - "integrity": "sha512-CCnwG71wvabmwq/qkz0HWIqBHQxw6pXB1uqt24dxqJ9WB34pVg49bL1sjXphlJHgTMWGhBjN1PicdyxDxrfP5A==", + "version": "25.7.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-25.7.0.tgz", + "integrity": "sha512-PWLUEXeeF7C9QGKqvdSbzLOiLTx+bno7/HC9eefePfEb257QFHg7ye3dh80AZVkaa/RQsBB1Q/ORQvg2X7F0NQ==", "dev": true, "requires": { "@typescript-eslint/experimental-utils": "^5.0.0" @@ -25975,9 +25894,9 @@ } }, "eslint-visitor-keys": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.1.0.tgz", - "integrity": "sha512-yWJFpu4DtjsWKkt5GeNBBuZMlNcYVs6vRCLoCVEJrTjaSB6LC98gFipNK/erM2Heg/E8mIK+hXG/pJMLK+eRZA==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.2.0.tgz", + "integrity": "sha512-IOzT0X126zn7ALX0dwFiUQEdsfzrm4+ISsQS8nukaJXwEyYKRSnEIIDULYg1mCtGp7UUXgfGl7BIolXREQK+XQ==", "dev": true }, "espree": { diff --git a/package.json b/package.json index e8bf440555c..7bc8d02640c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "tinybase", - "version": "1.0.0", + "version": "1.0.1", "author": "jamesgpearce", "repository": "github:tinyplex/tinybase", "license": "MIT", @@ -21,6 +21,7 @@ ".": "./lib/tinybase.js", "./*": "./lib/*.js" }, + "types": "./lib/tinybase.d.ts", "browser": { "fs": false }, @@ -73,9 +74,9 @@ "country-flag-emoji-json": "^2.0.0", "cspell": "^5.15.2", "esbuild": "^0.14.11", - "eslint": "^8.6.0", + "eslint": "^8.7.0", "eslint-config-prettier": "^8.3.0", - "eslint-plugin-jest": "^25.3.4", + "eslint-plugin-jest": "^25.7.0", "eslint-plugin-jsdoc": "^37.6.1", "eslint-plugin-react": "^7.28.0", "eslint-plugin-react-hooks": "^4.3.0", diff --git a/readme.md b/readme.md index 9c1d3fb4be6..985cf9b2a08 100644 --- a/readme.md +++ b/readme.md @@ -192,4 +192,4 @@ console.log(store.getCell('pets', 'felix', 'sold')); // -> false ``` -

Did we say tiny?

If you use the basic store module alone, you'll only add a gzipped 2.6kB to your app. You can incrementally add the other modules as you need more functionality, or get it all for 5.5kB. The ui-react adaptor is just another 2.6kB, and everything is fast.

Life's easy when you have zero dependencies.

Read more about how TinyBase is structured in the Architecture guide.

 .js.gz.jsdebug.js.d.ts
store2.6kB5.8kB23.8kB86.9kB
indexes1.5kB2.9kB13.0kB27.4kB
metrics1.5kB3.0kB12.3kB26.6kB
relationships1.5kB3.1kB14.3kB39.0kB
checkpoints1.3kB2.4kB10.0kB30.7kB
persisters0.8kB1.6kB4.9kB26.7kB
common0.1kB0.1kB0.1kB3.5kB
tinybase5.5kB13.0kB53.9kB0.3kB

Well tested and documented.

TinyBase has 100.0% test coverage, including the code throughout the documentation - even on this page! The guides, demos, and API examples are designed to make it as easy as possible to get up and running.

Read more about how TinyBase is tested in the Unit Testing guide.

 TotalTestedCoverage
Lines933933100.0%
Statements1,0181,018100.0%
Functions366366100.0%
Branches341341100.0%
Tests1,712
Assertions7,959

Get started

Try the demos

Read the docs


Follow

About

Building TinyBase was an interesting exercise in API design, minification, and documentation. It's not my day job, but I do intend to maintain it, so please provide feedback. I could not have done this without these great projects and friends, and I hope you enjoy using it!

\ No newline at end of file +

Did we say tiny?

If you use the basic store module alone, you'll only add a gzipped 2.6kB to your app. You can incrementally add the other modules as you need more functionality, or get it all for 5.5kB. The ui-react adaptor is just another 2.6kB, and everything is fast.

Life's easy when you have zero dependencies.

Read more about how TinyBase is structured in the Architecture guide.

 .js.gz.jsdebug.js.d.ts
store2.6kB5.8kB23.8kB86.9kB
indexes1.5kB2.9kB13.0kB27.4kB
metrics1.5kB3.0kB12.3kB26.6kB
relationships1.5kB3.1kB14.3kB39.0kB
checkpoints1.3kB2.4kB10.0kB30.7kB
persisters0.8kB1.6kB4.9kB26.7kB
common0.1kB0.1kB0.1kB3.5kB
tinybase5.5kB13.0kB53.9kB0.3kB

Well tested and documented.

TinyBase has 100.0% test coverage, including the code throughout the documentation - even on this page! The guides, demos, and API examples are designed to make it as easy as possible to get up and running.

Read more about how TinyBase is tested in the Unit Testing guide.

 TotalTestedCoverage
Lines933933100.0%
Statements1,0181,018100.0%
Functions366366100.0%
Branches341341100.0%
Tests1,712
Assertions7,959

Get started

Try the demos

Read the docs


Follow

About

Building TinyBase was an interesting exercise in API design, minification, and documentation. It's not my day job, but I do intend to maintain it, so please provide feedback. I could not have done this without these great projects and friends, and I hope you enjoy using it!

\ No newline at end of file