@pbvision/fastify-firestore-service 0.0.50

package/LICENSE

@@ -0,0 +1,204 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+This project was inspired by and forked from the Todea App library here:
+https://github.com/pocketgems/app

package/README.md

@@ -0,0 +1,187 @@
+# Fastify Firestore Service <!-- omit in toc -->
+This is a backend web framework built on Fastify and our Firestore ORM. It
+provides a way to define APIs, including managing data.
+
+[![JSDoc](https://img.shields.io/badge/Documentation-JSDoc-green.svg?logo=githubpages)](https://pbv-public.github.io/fastify-firestore-service)
+
+## Topics <!-- omit in toc -->
+- [Key Features](#key-features)
+- [Getting Started](#getting-started)
+  - [Creating An API](#creating-an-api)
+  - [Creating a Service](#creating-a-service)
+  - [Running a Server](#running-a-server)
+  - [Setting up Error Reporting](#setting-up-error-reporting)
+- [Components](#components)
+  - [Customizing Component Registration](#customizing-component-registration)
+- [Unit testing](#unit-testing)
+- [Generating SDKs](#generating-sdks)
+  - [Swagger UI](#swagger-ui)
+  - [OpenAPI SDKs](#openapi-sdks)
+
+# Key Features
+- [API library](docs/api.md)
+  - Routing
+  - Schemas for API inputs and responses
+  - CORS
+  - Compression
+  - Health check API
+  - Advanced error handling
+  - Works with the [Firestore ORM library](https://github.com/pbv-public/firestore-orm)
+
+# Getting Started
+
+## Creating An API
+You can create an API to fetch information from Firestore like this:
+```js
+import { DatabaseAPI, EXCEPTIONS } from '@pbvision/fastify-firestore-service'
+
+class GetOrderAPI extends DatabaseAPI {
+  static PATH = '/getOrder'
+  static DESC = `Get an order by ID, if order doesn't exists a 404 Not found
+    error is returned`
+
+  static INPUT = Order.KEY
+  static OUTPUT = {
+    order: Order.Schema
+  }
+  static ERRORS = {
+    EXCEPTIONS.NotFoundException
+  }
+
+  async computeResponse ({ tx, body }) {
+    const order = await tx.get(Order, body.id)
+    if (!order) {
+      throw new NotFoundException()
+    }
+    return { order: order.toJSON() }
+  }
+}
+```
+
+You can read more about the API interface [here](docs/api.md).
+
+## Creating a Service
+A service is just a server which hosts some HTTP APIs. To create a service, you
+call `makeService` like this:
+```js
+import { makeService } from '@pbvision/fastify-firestore-service'
+
+const components = {
+  Order,
+  GetOrderAPI
+}
+```
+```javascript <!-- embed:src/app.js:section:example start:example end -->
+export default async (params) => makeService({
+  service: 'unittest',
+  components,
+  cookie: {
+    secret: 'unit-test'
+  },
+  logging: {
+    reportErrorDetail: true, // process.env.NODE_ENV === 'localhost',
+    reportAllErrors: true // process.env.NODE_ENV !== 'prod'
+  },
+  swagger: {
+    disabled: false,
+    authHeaders: ['x-app', 'x-uid'],
+    servers: ['http://localhost:8080'],
+    routePrefix: '/app/docs'
+  },
+  ...(params ?? {})
+})
+```
+
+## Running a Server
+The `makeService()` helper method creates a fastify instance with a few plugins
+loaded already. You may customize the fastify instance further using fastify's
+customization features. To start the app, you have to call `.listen()` according
+to
+[Fastify's documentation](https://www.fastify.io/docs/latest/Reference/Server/#listen).
+For example, `makeService()` is called in a `app.js` file, and the returned promise
+is exported, then you write the following code to start a server:
+```javascript <!-- embed:examples/server.js:section:example start:example end -->
+const app = await makeTestApp(params)
+app.listen({ port: 8090, host: '0.0.0.0' })
+```
+
+## Setting up Error Reporting
+Any 500 HTTP response will be logged to Sentry if:
+* The `NODE_ENV` environment variable is not localhost
+* The service's logging configuration has the `sentryDSN` parameter set
+
+The Sentry repo will include:
+* Information about the user like ID or IP, as well as their user agent header
+* Information about the request including HTTP method, URL and response code
+* A unique ID for the request (the first part is a UUID identifying the
+  fastify instance which is running, and the second part is a number indicating
+  this requests unique number on this instance)
+* Stack trace of the error
+* Environment name (e.g., test or prod)
+* Release = git hash of the source code for the service that's running
+
+
+# Components
+A service is composed of components. A component can be an API, a DB Model,
+etc. These components are passed to `makeService()` which calls the
+`register()` method on each component so that it can do any setup it requires:
+
+```js
+const components = {
+  Order,
+  GetOrderAPI
+}
+
+makeService({
+  components,
+  ...
+})
+```
+
+For example, API's register with fastify as a route.
+
+## Customizing Component Registration
+The component system uses a visitor pattern to allow extending the registration
+workflow with custom components. For example, to add a new type of component
+`ExampleComponent`, you need to do the following:
+1. Subclass `ComponentRegistrar`, and add a
+   `registerExampleComponent (exampleComponent)` method
+   ```js
+   import { ComponentRegistrar } from '@pbvision/fastify-firestore-service'
+
+   class CustomComponentRegistrar extends ComponentRegistrar {
+       registerExampleComponent (exampleComponent) {
+           // do what needs to be done
+       }
+   }
+   ```
+1. You can pass the new `CustomComponentRegistrar` class to
+   [makeService()](./make-app.md) like this
+   ```js
+   makeService({
+       RegistrarCls: CustomComponentRegistrar
+   })
+   ```
+1. Implement `static register (registrar)` in the new `ExampleComponent` class
+   ```js
+   class ExampleComponent {
+       static register (registrar) {
+           registrar.registerExampleComponent(this)
+       }
+   }
+   ```
+1. Pass the new type of component as part of `components` like this
+   `makeService({ components: { ExampleComponent } })`
+
+# Unit testing
+# Generating SDKs
+## Swagger UI
+This library generates an interactive Swagger UI for all APIs at /[service]/docs.
+
+## OpenAPI SDKs
+You can export APIs in an OpenAPI schema from /[service]/docs/json, and use that
+with OpenAPI / Swagger SDK to generate SDKs in any supported languages.
+
+CAUTION: Swagger SDKs use positional arguments in all SDKs, maintaining backward
+compatibility will be challenging with vanilla SDK generators. You may customize
+the generators to pass keyword arguments instead for languages that support it.