Merge pull request #17 from nestjs-addons/add_docs_page

docs(platform): add docusaurus project with documentation

Author: DominikPieper

.gitignore

@@ -37,3 +37,7 @@ testem.log
 # System Files
 .DS_Store
 Thumbs.db
+
+# Generated Docusaurus files
+.docusaurus/
+.cache-loader/

.prettierignore

@@ -2,3 +2,4 @@
 
 /dist
 /coverage
+.docusaurus/

nx.json

@@ -35,6 +35,9 @@
     },
     "spectator": {
       "tags": []
+    },
+    "docs": {
+      "tags": []
     }
   },
   "workspaceLayout": {

package.json

@@ -29,9 +29,15 @@
   },
   "private": true,
   "dependencies": {
+    "@docusaurus/core": "^2.0.0-alpha.70",
+    "@docusaurus/plugin-sitemap": "^2.0.0-alpha.70",
+    "@docusaurus/preset-classic": "^2.0.0-alpha.70",
     "@nestjs/common": "^7.6.11",
     "@nestjs/core": "^7.6.11",
     "@nestjs/platform-express": "^7.6.11",
+    "clsx": "^1.1.1",
+    "react": "^16.8.4",
+    "react-dom": "^16.8.4",
     "reflect-metadata": "^0.1.13",
     "rxjs": "~6.6.3"
   },
@@ -44,6 +50,7 @@
     "@nrwl/nest": "11.2.12",
     "@nrwl/node": "11.2.12",
     "@nrwl/tao": "11.2.12",
+    "@nx-plus/docusaurus": "10.4.0",
     "@nrwl/workspace": "11.2.12",
     "@types/jest": "26.0.15",
     "@types/node": "12.12.38",
@@ -62,6 +69,9 @@
     "tslint": "6.1.3",
     "typescript": "4.0.5"
   },
+  "resolutions": {
+    "terser": "^4.0.0"
+  },
   "config": {
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"

packages/docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

packages/docs/blog/2019-05-28-hola.md

@@ -0,0 +1,11 @@
+---
+slug: hola
+title: Hola
+author: Gao Wei
+author_title: Docusaurus Core Team
+author_url: https://github.com/wgao19
+author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

packages/docs/blog/2019-05-29-hello-world.md

@@ -0,0 +1,17 @@
+---
+slug: hello-world
+title: Hello
+author: Endilie Yacop Sucipto
+author_title: Maintainer of Docusaurus
+author_url: https://github.com/endiliey
+author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
+tags: [hello, docusaurus]
+---
+
+Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
+
+<!--truncate-->
+
+This is a test post.
+
+A whole bunch of other information.

packages/docs/blog/2019-05-30-welcome.md

@@ -0,0 +1,13 @@
+---
+slug: welcome
+title: Welcome
+author: Yangshun Tay
+author_title: Front End Engineer @ Facebook
+author_url: https://github.com/yangshun
+author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4
+tags: [facebook, hello, docusaurus]
+---
+
+Blog features are powered by the blog plugin. Simply add files to the `blog` directory. It supports tags as well!
+
+Delete the whole directory if you don't want the blog features. As simple as that!

packages/docs/docs/IMDB-apidoc.md

@@ -0,0 +1,188 @@
+---
+id: in-memory-db-apidoc
+title: API Documentation
+---
+
+## `InMemoryDBService<T extends InMemoryEntity>`
+
+This is the service that provides the in-memory database. All methods interact with a `records` array and implement `generics` to provide type-safety and intellisense based on the `T extends InMemoryEntity` passed in.
+
+### Public Methods
+
+**`public create(record: Partial<T>, getNextId?: () => string): T`**
+
+This method takes in a `Partial<T>` as we do not always know the `id` for a record when we are creating. If we leave off the `id` property the service will automatically generate an `id` for us. Upon successful creation, the method returns the record with the newly generated `id`. An optional parameter of `getNextId` can be used to pass a function that returns a `string` and will be used by the service to get the next id. By default this uses the `uuid` npm package.
+
+Example Usage:
+
+```typescript
+const newUser = this.userService.create({
+  firstName: 'Some',
+  lastName: 'Person',
+});
+
+console.log({ newUser });
+
+// logs out
+// {
+//     newUser: {
+//        id: 1,
+//        firstName: 'Some',
+//        lastName: 'Person,
+//    }
+// }
+```
+
+**`public createMany(records: Array<Partial<T>>, getNextId?: () => string): T[]`**
+
+This method takes in an array of `Partial<T>` as we do not always know the `id` for records when we are creating. If we leave off the `id` properties the service will automatically generate `id`s for us. Upon successful creation, the method returns the an array of records with the newly generated `id`s. An optional parameter of `getNextId` can be used to pass a function that returns a `string` and will be used by the service to get the next id. By default this uses the `uuid` npm package.
+
+Example Usage:
+
+```typescript
+const recordsToCreate = [
+  {
+    firstName: 'Some',
+    lastName: 'Person',
+  },
+  {
+    firstName: 'Other',
+    lastName: 'Person',
+  },
+];
+
+const newUsers = this.userService.createMany(recordsToCreate);
+
+console.log({ newUsers });
+
+// logs out
+// {
+//     newUsers: [{
+//        id: 1,
+//        firstName: 'Some',
+//        lastName: 'Person,
+//    },
+//    {
+//        id: 2,
+//        firstName: 'Other',
+//        lastName: 'Person,
+//    }]
+// }
+```
+
+**`public update(record: T): void`**
+
+This method takes in a `T` record object and updates the record in the `records` array based on the `id` in the object. This method does not return a value.
+
+Example Usage:
+
+```typescript
+this.userService.update({
+  id: 1,
+  firstName: 'Other',
+  lastName: 'Person',
+});
+```
+
+**`public delete(id: string): void`**
+
+This method takes in a `id: string` and deletes the record from the `records` array based on the `id` in the object. This method does not return a value.
+
+Example Usage:
+
+```typescript
+this.userService.delete('1');
+```
+
+**`public get(id: string): T`**
+
+This method takes in a `id: string` and returns the record from the `records` array based on the `id` in the object.
+
+Example Usage:
+
+```typescript
+const foundUser = this.userService.get('1');
+
+console.log({ foundUser });
+
+// logs out
+// {
+//     foundUser: {
+//         id: '1',
+//         firstName: 'Some',
+//         lastName: 'Person'
+//    }
+// }
+```
+
+**`public getAll(): T[]`**
+
+This method has no parameters and returns the all from the `records` array.
+
+Example Usage:
+
+```typescript
+const allUsers = this.userService.getAll();
+
+console.log({ allUsers });
+
+// logs out
+// {
+//   allUsers: [
+//     {
+//       id: '1',
+//       firstName: 'Some',
+//       lastName: 'Person'
+//     },
+//     {
+//       id: '2',
+//       firstName: 'Other',
+//       lastName: 'Person'
+//     }
+//   ];
+// }
+```
+
+**`public query(predicate: (record: T) => boolean): T[]`**
+
+This method has takes in a `record: T` predicate and returns all from the `records` array that meet that predicate's requirements.
+
+Example Usage:
+
+```typescript
+const foundUsers = this.userService.query(
+  (record) => record.lastName === 'Person',
+);
+
+console.log({ foundUsers });
+
+// logs out
+// {
+//   allUsers: [
+//     {
+//       id: '1',
+//       firstName: 'Some',
+//       lastName: 'Person'
+//     },
+//     {
+//       id: '2',
+//       firstName: 'Other',
+//       lastName: 'Person'
+//     }
+//   ];
+// }
+```
+
+### Public Properties
+
+- `records: T[]` - This is the in-memory array used in all crud and read operations for the service. Please access with care.
+
+## `InMemoryDBEntity`
+
+This is an interface used by the `InMemoryDBService` for intellisense and type-safety. Do not use this interface directly. Rather, implement your own `interface` that `extends` this.
+
+```typescript
+export interface InMemoryDBEntity {
+  id: string;
+}
+```

packages/docs/docs/IMDB-description.md

@@ -0,0 +1,8 @@
+---
+id: in-memory-db-index
+title: Introduction
+---
+
+`@nestjs-addons/in-memory-db` provides a ridiculously simple, no configuration needed, way to create a simple in-memory database for use in your `nestjs` applications. You simply define an `interface` that extends the `interface InMemoryDBEntity`, inject the `InMemoryDBService<T>` into your controllers and/or services, and immediately profit. The records are stored in-memory, as a singleton, for each interface, for the life of the service.
+
+This provides a great way to quickly get up and running with prototypes and mock backends.