Refactor cache item interface

.changeset/honest-beds-exist.md

@@ -0,0 +1,8 @@
+---
+'@soluble/cache-e2e-tests': minor
+'@soluble/cache-interop': minor
+'@soluble/cache-ioredis': minor
+'@soluble/cache-redis': minor
+---
+
+Added isSuccess, isHit in payload

.changeset/itchy-onions-itch.md

@@ -0,0 +1,8 @@
+---
+'@soluble/cache-e2e-tests': minor
+'@soluble/cache-interop': minor
+'@soluble/cache-ioredis': minor
+'@soluble/cache-redis': minor
+---
+
+Add onError option to has() method

.changeset/lazy-rocks-sing.md

@@ -0,0 +1,8 @@
+---
+'@soluble/cache-e2e-tests': minor
+'@soluble/cache-interop': minor
+'@soluble/cache-ioredis': minor
+'@soluble/cache-redis': minor
+---
+
+CacheItem returns {data} rather than {value} (BC)

.changeset/perfect-pens-destroy.md

@@ -0,0 +1,8 @@
+---
+'@soluble/cache-e2e-tests': minor
+'@soluble/cache-interop': minor
+'@soluble/cache-ioredis': minor
+'@soluble/cache-redis': minor
+---
+
+Export of Guards and Asserts

.changeset/rich-trains-run.md

@@ -0,0 +1,8 @@
+---
+'@soluble/cache-e2e-tests': minor
+'@soluble/cache-interop': minor
+'@soluble/cache-ioredis': minor
+'@soluble/cache-redis': minor
+---
+
+Add InvalidCacheKeyException checks

.changeset/tiny-mirrors-help.md

@@ -0,0 +1,8 @@
+---
+'@soluble/cache-e2e-tests': minor
+'@soluble/cache-interop': minor
+'@soluble/cache-ioredis': minor
+'@soluble/cache-redis': minor
+---
+
+Fix typing exports

CONTRIBUTING.md

@@ -2,6 +2,29 @@
 
 Fork this repo and contribute a P/R.
 
+## Running tests
+
+Tests are separated in unit and e2e, you can launch them separately:
+
+### Unit tests
+
+The convention for unit tests is to place them in their respective packages and 
+colocate them in a `__test__` subfolder. You can run
+them by:
+
+```bash
+$ yarn test:unit
+```
+
+### E2E tests
+
+E2E tests are packaged separately in [./packages/cache-e2e-tests/test](https://github.com/soluble-io/cache-interop/tree/main/packages/cache-e2e-tests) 
+to allow coverage of all adapters.
+
+> Note that `test:e2e` requires docker installed on your machine. 
+> If you don't want to to install docker, you can rely
+> on the [github action](https://github.com/soluble-io/cache-interop/blob/main/.github/workflows/ci.yml). 
+
 ## Structure
 
 This monorepo holds the various adapters, the contracts for interoperability and the e2e tests.
@@ -20,4 +43,3 @@ This monorepo holds the various adapters, the contracts for interoperability and
      └── # e2e test suite for all adapters #
 ```
 
-

README.md

@@ -29,6 +29,9 @@
   </a>
 </p>
 
+
+# About | [Documentation](https://github.com/soluble-io/cache-interop/)
+
 > **This project is in early architectural definition ;)**
 
 
@@ -69,9 +72,9 @@ const cache = new IoRedisCacheAdapter({
 
 const asyncFetch = () => myFetch('/api').then(r => JSON.stringify(r));
 
-const { value, error } = await cache.getOrSet('key', asyncFetch(), { ttl: 3600 });
+const { data, error } = await cache.getOrSet('key', asyncFetch(), { ttl: 3600 });
 
-if (value !== null) {
+if (data !== null) {
   // do something
 }
 ```

package.json

@@ -54,6 +54,7 @@
     "lerna": "^3.22.1",
     "lint-staged": "^10.5.3",
     "microbundle": "^0.13.0",
+    "moq.ts": "^7.0.0",
     "npm-check-updates": "^10.2.5",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",

packages/cache-e2e-tests/README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <h1 align="center"><a aria-label="soluble/cache-e2e-tests" href="https://github.com/soluble-io/cache-interop/tree/main/packages/cache-e2e-tests">@soluble/cache-e2e-tests</a></h1>
-  <h4 align="center"><a aria-label="soluble/cache-interop" href="">@soluble/cache-interop</a> E2E shared test suites.</h4>
+  <h4 align="center"><a aria-label="soluble/cache-interop" href="https://github.com/soluble-io/cache-interop">@soluble/cache-interop</a> E2E shared test suites.</h4>
 </div>
 <p align="center">
   <a aria-label="Coverage" href="https://codecov.io/gh/soluble-io/cache-interop">
@@ -10,12 +10,32 @@
   <img alt="Typescript" src="https://img.shields.io/badge/Typescript-4.+-blue?logo=typescript&style=for-the-badge&labelColor=000000" />
 </p>
 
+## About
+
+The e2e package provides a shared suite for all [@soluble/cache-interop](https://github.com/soluble-io/cache-interop)
+official adapters.
+
+> Note that `test:e2e` requires docker installed on your machine.
+> If you don't want to to install docker, you can rely
+> on the [github action](https://github.com/soluble-io/cache-interop/blob/main/.github/workflows/ci.yml).
+
+## Install
+
+```bash
+$ yarn install
+```
+
 ## Run tests
 
 ```bash
 $ yarn test:e2e
 ```
 
+## Environments
+
+The `test:e2e` uses [node-testcontainers](https://github.com/testcontainers/testcontainers-node) under the hood to
+spin redis 5 and redis 6 instances.
+
 ## Contribute
 
 See the [@soluble/cache-interop CONTRIBUTING.md](https://github.com/soluble-io/cache-interop/blob/main/CONTRIBUTING.md) guide.