Initial commit

Author: dios-david

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = crlf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @dios-david

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+# Description
+
+Please include a summary of the change here.
+
+## Type of change
+
+Please check options that are relevant:
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update

.gitignore

@@ -0,0 +1,3 @@
+.cache
+node_modules
+dist

.np-config.json

@@ -0,0 +1,3 @@
+{
+    "yarn": false
+}

.npmignore

@@ -0,0 +1,5 @@
+**/*
+!dist/**/*
+!package.json
+!package-lock.json
+!LICENSE

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing to apollo-cache-lite
+
+👍🎉 Thanks for taking the time to contribute! 🎉👍
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## We develop with GitHub
+
+We use GitHub to host the code, track issues and feature requests.
+
+## Code changes happen through pull requests
+
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code passes the linters.
+6. Open that pull request!
+
+## Any contributions you make will be under the GNU GPLv3 Software License
+
+In short, when you submit code changes, your submissions are understood to be under the same [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using GitHub's [issues](https://github.com/thedevcore/apollo-cache-lite/issues)
+
+We use GitHub issues to track public bugs. Report a bug by opening a new issue - it's that easy!
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Provide a sample code if you can
+- What you expected would happen
+- What actually happens
+- Notes - possibly including why you think this might be happening, or stuff you tried that didn't work
+
+❤️📝 People **love** detailed bug reports!
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its GNU GPLv3 License.

LICENSE

@@ -0,0 +1,52 @@
+# apollo-cache-lite
+
+A lightweight cache implementation for [Apollo Client](https://github.com/apollographql/apollo-client).
+
+## Features
+
+- 🚀 **Lightweight** - **Supports the most frequently used use-cases:** SSR, extracting cache state, restoring cache state in browser, reading fragments from cache
+- 🔥 **Fast** - Read/write **performance is the top priority** to make your Apollo app faster
+- 🚨 **Beta** - Use it carefully, it's **not production ready yet!**
+
+## Getting started
+
+1. Install with npm or yarn:
+
+```shell
+npm i --save apollo-cache-lite
+
+yarn add apollo-cache-lite
+```
+
+2. Import in your app:
+```js
+import { ApolloClient } from 'apollo-client';
+import { ApolloCacheLite } from 'apollo-cache-lite';
+
+const client = new ApolloClient({
+    cache: new ApolloCacheLite(),
+    // other apollo-client options…
+});
+```
+
+## Options
+
+The ApolloCacheLite constructor takes an optional configuration object to customize the cache:
+
+### `getIdFromObject`
+
+A function that takes a data object and returns a unique identifier.
+
+```js
+import { ApolloCacheLite, getDefaultIdFromNode } from 'apollo-cache-lite';
+
+const cache = new ApolloCacheLite({
+    getIdFromObject(object) {
+        switch (object.__typename) {
+            case 'foo': return object.key; // use `key` as the primary key
+            case 'bar': return `bar:${object.blah}`; // use `bar` prefix and `blah` as the primary key
+            default: return getDefaultIdFromNode(object); // fall back to default handling
+        }
+    }
+});
+```

README.md

@@ -0,0 +1,187 @@
+const { ApolloClient } = require('apollo-client');
+const { SchemaLink } = require('apollo-link-schema');
+const { makeExecutableSchema } = require('graphql-tools');
+const gql = require('graphql-tag');
+
+const { ApolloCacheLite } = require('../src/ApolloCacheLite');
+const resolvers = require('./test-utils/resolvers');
+const typeDefs = require('./test-utils/type-defs');
+
+function createApolloClient() {
+    const schema = makeExecutableSchema({ typeDefs, resolvers });
+
+    return new ApolloClient({
+        cache: new ApolloCacheLite(),
+        link: new SchemaLink({ schema })
+    });
+}
+
+describe('ApolloCacheLite', () => {
+    it('should export a class', () => {
+        expect(ApolloCacheLite).toBeDefined();
+        expect(new ApolloCacheLite()).toBeInstanceOf(ApolloCacheLite);
+    });
+
+    it('client.query() / cache.write() :: should store query and cacheable nodes', async () => {
+        const client = createApolloClient();
+
+        const { data } = await client.query({
+            query: gql(`{
+                getBook(id: 1) {
+                    id
+                    title
+                    author {
+                        id
+                        name
+                    }
+                }
+            }`)
+        });
+
+        const { queries, store } = client.cache.extract();
+
+        expect(data).toEqual({
+            getBook: {
+                __typename: 'Book',
+                id: '1',
+                title: 'Test book',
+                author: {
+                    __typename: 'Author',
+                    id: '1',
+                    name: 'D'
+                }
+            }
+        });
+
+        expect(queries).toEqual({ '-702561878___3938': data });
+
+        expect(store).toEqual({
+            Author: {
+                '1': {
+                    __typename: 'Author',
+                    id: '1',
+                    name: 'D'
+                }
+            },
+            Book: {
+                '1': {
+                    __typename: 'Book',
+                    id: '1',
+                    title: 'Test book',
+                    author: {
+                        __typename: 'Author',
+                        id: '1',
+                        name: 'D'
+                    }
+                }
+            }
+        });
+    });
+
+    it('client.readQuery() / cache.read() :: should return cached result for a query', async () => {
+        const client = createApolloClient();
+        const options = {
+            query: gql(`{
+                getBook(id: 1) {
+                    id
+                    title
+                    author {
+                        id
+                        name
+                    }
+                }
+            }`)
+        };
+
+        // calling client.readQuery() with cold cache should return undefined
+        expect(await client.readQuery(options)).not.toBeDefined();
+
+        // cache warmup
+        await client.query(options);
+
+        // test client.readQuery() with warm cache
+        const data = await client.readQuery(options);
+        const { queries, store } = client.cache.extract();
+
+        expect(data).toEqual({
+            getBook: {
+                __typename: 'Book',
+                id: '1',
+                title: 'Test book',
+                author: {
+                    __typename: 'Author',
+                    id: '1',
+                    name: 'D'
+                }
+            }
+        });
+
+        expect(queries).toEqual({ '-702561878___3938': data });
+
+        expect(store).toEqual({
+            Author: {
+                '1': {
+                    __typename: 'Author',
+                    id: '1',
+                    name: 'D'
+                }
+            },
+            Book: {
+                '1': {
+                    __typename: 'Book',
+                    id: '1',
+                    title: 'Test book',
+                    author: {
+                        __typename: 'Author',
+                        id: '1',
+                        name: 'D'
+                    }
+                }
+            }
+        });
+    });
+
+    it('client.readFragment() / cache.readFragment() :: should return cached node', async () => {
+        const client = createApolloClient();
+
+        // cache warmup
+        await client.query({
+            query: gql(`{
+                getBook(id: 1) {
+                    id
+                    title
+                    author {
+                        id
+                        name
+                    }
+                }
+            }`)
+        });
+
+        // test readFragment() with warm cache
+        const data = client.readFragment({
+            id: 'Book:1',
+            fragment: `
+                fragment fullBookDetails on Book {
+                    id
+                    title
+                    author {
+                        id
+                        name
+                    }
+                }
+            `
+        });
+
+        expect(data).toEqual({
+            __typename: 'Book',
+            id: '1',
+            title: 'Test book',
+            author: {
+                __typename: 'Author',
+                id: '1',
+                name: 'D'
+            }
+        });
+    });
+});