rest-hapi is powering the APIs of these projects...
37 |Is your project using rest-hapi?
41 | 42 | Add your logo 43 | 44 |
30 |
31 | ## Backers
32 |
33 | Support us with a monthly donation and help us continue our activities!
34 | [Become a backer](https://opencollective.com/rest-hapi#backers).
35 |
36 | 
37 |
38 |
39 | ## License
40 | rest-hapi is licensed under a [MIT License](https://github.com/JKHeadley/rest-hapi/blob/master/LICENSE.txt).
41 |
--------------------------------------------------------------------------------
/website/versioned_docs/version-1.6.x/support.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: version-1.6.x-support
3 | title: Support
4 | sidebar_label: Support
5 | original_id: support
6 | ---
7 |
8 | Like this project? Please [star it](https://github.com/JKHeadley/rest-hapi)!
9 |
10 | ## Contributing
11 |
12 | We welcome contributions to rest-hapi! These are the many ways you can help:
13 |
14 | - Submit patches and features
15 | - Improve the documentation and website (created with [docusaurus](https://docusaurus.io/), check it out!)
16 | - Report bugs
17 | - Follow us on [Twitter](https://twitter.com/resthapi)
18 | - Participate in the [gitter community](https://gitter.im/rest-hapi/Lobby)
19 | - And [donate financially](https://opencollective.com/rest-hapi)!
20 |
21 | Please read our [contribution guide](https://github.com/JKHeadley/rest-hapi/blob/master/CONTRIBUTING.md) to get started. Also note
22 | that this project is released with a
23 | [Contributor Code of Conduct](https://github.com/JKHeadley/rest-hapi/blob/master/CODE_OF_CONDUCT.md), please make sure to review
24 | and follow it.
25 |
26 | ## Contributors
27 |
28 | Of course we want to thank all of our current contributors!
29 |
30 |
31 |
32 | ## Backers
33 |
34 | Support us with a monthly donation and help us continue our activities!
35 | [Become a backer](https://opencollective.com/rest-hapi#backers).
36 |
37 |
38 |
39 |
40 | ## License
41 | rest-hapi is licensed under a [MIT License](https://github.com/JKHeadley/rest-hapi/blob/master/LICENSE.txt).
42 |
--------------------------------------------------------------------------------
/policies/add-document-scope.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const Boom = require('@hapi/boom')
4 | const _ = require('lodash')
5 |
6 | const internals = {}
7 |
8 | /**
9 | * Policy to append any document scopes defined in the routeOptions to any existing scope.
10 | * @param model
11 | * @param logger
12 | * @returns {addDocumentScopeForModel}
13 | */
14 | internals.addDocumentScope = function(model, logger) {
15 | const addDocumentScopeForModel = function addDocumentScopeForModel(
16 | request,
17 | h
18 | ) {
19 | const Log = logger.bind('addDocumentScope')
20 | try {
21 | const scope = model.routeOptions.documentScope
22 |
23 | if (scope) {
24 | for (const scopeType in scope) {
25 | if (_.isArray(request.payload)) {
26 | request.payload.forEach(function(document) {
27 | document.scope = document.scope || {}
28 | document.scope[scopeType] = document.scope[scopeType] || []
29 | document.scope[scopeType] = document.scope[scopeType].concat(
30 | scope[scopeType]
31 | )
32 | })
33 | } else {
34 | request.payload.scope = request.payload.scope || {}
35 | request.payload.scope[scopeType] =
36 | request.payload.scope[scopeType] || []
37 | request.payload.scope[scopeType] = request.payload.scope[
38 | scopeType
39 | ].concat(scope[scopeType])
40 | }
41 | }
42 | }
43 |
44 | return h.continue
45 | } catch (err) {
46 | Log.error('ERROR:', err)
47 | throw Boom.badImplementation(err)
48 | }
49 | }
50 |
51 | addDocumentScopeForModel.applyPoint = 'onPreHandler'
52 |
53 | return addDocumentScopeForModel
54 | }
55 |
56 | internals.addDocumentScope.applyPoint = 'onPreHandler'
57 |
58 | module.exports = {
59 | addDocumentScope: internals.addDocumentScope
60 | }
61 |
--------------------------------------------------------------------------------
/.github/workflows/manual.yml:
--------------------------------------------------------------------------------
1 | # This is a basic workflow that is manually triggered
2 |
3 | # HOW TO USE
4 | # One of the challenges with testing NEW github workflows is that you can't trigger them without first
5 | # having the workflow existing in the main branch of the repo.
6 | # Once that workflow is there, you can update the workflow on any branch, and run that branch's version
7 | # of the workflow. So to use this and test a manually triggered workflow:
8 | # 1. Check out a new branch and modify this file
9 | # 2. Push your branch, then in your browser, navigate to the Github workflow
10 | # 3. Click on "Manual workflow" and trigger it, specifying your branch.
11 |
12 | name: Manual workflow
13 |
14 | # Controls when the action will run. Workflow runs when manually triggered using the UI
15 | # or API.
16 | on:
17 | workflow_dispatch:
18 | # Inputs the workflow accepts.
19 | inputs:
20 | name:
21 | # Friendly description to be shown in the UI instead of 'name'
22 | description: 'Person to greet'
23 | # Default value if no value is explicitly provided
24 | default: 'World'
25 | # Input has to be provided for the workflow to run
26 | required: true
27 |
28 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel
29 | jobs:
30 | # This workflow contains a single job that can be modified on a branch to test behaviors
31 | scratch-job:
32 | # The type of runner that the job will run on
33 | runs-on: ubuntu-latest
34 |
35 | # Steps represent a sequence of tasks that will be executed as part of the job
36 | steps:
37 | # Runs a single command using the runners shell
38 | - name: Send greeting
39 | run: echo "Hello ${{ github.event.inputs.name }}"
40 | - name: Exit if failed match
41 | run: |
42 | echo $MATCH;
43 | echo ${#MATCH};
44 | if [[ -z "$MATCH" ]]; then
45 | echo "this shouldn't print"
46 | fi
47 | env:
48 | MATCH: "asdf123"
49 |
--------------------------------------------------------------------------------
/docs/authentication.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: authentication
3 | title: Authentication
4 | sidebar_label: Authentication
5 | ---
6 |
7 | ## Route authentication
8 | Authentication for generated endpoints is configured through [`config.authStrategy`](configuration.md#authstrategy) property. If this property is set to a registered strategy, then that strategy is applied to all generated endpoints by default. For more details about authentication with hapi, see [the hapi docs](https://hapijs.com/tutorials/auth). For a working example of authentication with rest-hapi, see the [rest-hapi-demo-auth](https://github.com/JKHeadley/rest-hapi-demo/tree/feature/authentication) or [appy](https://github.com/JKHeadley/appy).
9 |
10 | You can disable authentication for generated CRUD endpoints by setting the correct property to ``false`` within the ``routeOptions`` object. Below is a list of properties and the endpoints they affect:
11 |
12 | Property | Affected endpoints when `false`
13 | --- | ---
14 | readAuth | ``GET /path`` and ``GET /path/{_id}`` endpoints
15 | createAuth | ``POST /path`` endpoint
16 | updateAuth | ``PUT /path/{_id}`` endpoint
17 | deleteAuth | ``DELETE /path`` and ``DELETE /path/{_id}`` endpoints
18 |
19 | Similarly, you can disable authentication for generated association endpoints through the following properties within each association object:
20 |
21 | Property | Affected endpoints when `false`
22 | --- | ---
23 | addAuth | ``POST /owner/{ownerId}/child`` and ``PUT /owner/{ownerId}/child/{childId}`` endpoints
24 | removeAuth | ``DELETE /owner/{ownerId}/child`` and ``DELETE /owner/{ownerId}/child/{childId}`` endpoints
25 | readAuth | ``GET /owner/{ownerId}/child`` endpoint
26 |
27 | For example, a routeOption object that disables authentication for creating objects and removing a specific association could look like this:
28 |
29 | ```javascript
30 | routeOptions: {
31 | createAuth: false,
32 | associations: {
33 | users: {
34 | type: "MANY_ONE",
35 | alias: "user",
36 | model: "user",
37 | removeAuth: false
38 | }
39 | }
40 | }
41 | ```
--------------------------------------------------------------------------------
/website/versioned_docs/version-1.6.x/authentication.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: version-1.6.x-authentication
3 | title: Authentication
4 | sidebar_label: Authentication
5 | original_id: authentication
6 | ---
7 |
8 | ## Route authentication
9 | Authentication for generated endpoints is configured through [`config.authStrategy`](configuration.md#authstrategy) property. If this property is set to a registered strategy, then that strategy is applied to all generated endpoints by default. For more details about authentication with hapi, see [the hapi docs](https://hapijs.com/tutorials/auth). For a working example of authentication with rest-hapi, see the [rest-hapi-demo-auth](https://github.com/JKHeadley/rest-hapi-demo/tree/feature/authentication) or [appy](https://github.com/JKHeadley/appy).
10 |
11 | You can disable authentication for generated CRUD endpoints by setting the correct property to ``false`` within the ``routeOptions`` object. Below is a list of properties and the endpoints they affect:
12 |
13 | Property | Affected endpoints when `false`
14 | --- | ---
15 | readAuth | ``GET /path`` and ``GET /path/{_id}`` endpoints
16 | createAuth | ``POST /path`` endpoint
17 | updateAuth | ``PUT /path/{_id}`` endpoint
18 | deleteAuth | ``DELETE /path`` and ``DELETE /path/{_id}`` endpoints
19 |
20 | Similarly, you can disable authentication for generated association endpoints through the following properties within each association object:
21 |
22 | Property | Affected endpoints when `false`
23 | --- | ---
24 | addAuth | ``POST /owner/{ownerId}/child`` and ``PUT /owner/{ownerId}/child/{childId}`` endpoints
25 | removeAuth | ``DELETE /owner/{ownerId}/child`` and ``DELETE /owner/{ownerId}/child/{childId}`` endpoints
26 | readAuth | ``GET /owner/{ownerId}/child`` endpoint
27 |
28 | For example, a routeOption object that disables authentication for creating objects and removing a specific association could look like this:
29 |
30 | ```javascript
31 | routeOptions: {
32 | createAuth: false,
33 | associations: {
34 | users: {
35 | type: "MANY_ONE",
36 | alias: "user",
37 | model: "user",
38 | removeAuth: false
39 | }
40 | }
41 | }
42 | ```
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to rest-hapi
2 |
3 | Hey there! We’re really excited that you are interested in contributing to
4 | rest-hapi. Before submitting your contribution though, please make sure to take
5 | a moment and read through the following guidelines.
6 |
7 | ## Code of Conduct
8 |
9 | Please note that this project has a [Code of Conduct](CODE_OF_CONDUCT.md). It's
10 | important that you review and enforce it.
11 |
12 | ## Code contributions
13 |
14 | Here is a quick guide to doing code contributions to the library.
15 |
16 | 1. Find some issue you're interested in, or a feature that you'd like to
17 | tackle. Also make sure that no one else is already working on it. If it's a
18 | feature you're requesting, make sure it's aligned with the direction of the
19 | project by creating an issue and discussing it with the core maintainers. We
20 | don't want you to be disappointed.
21 | 2. Fork the repo
22 | 3. Create a branch off of the *master* branch. Prefix your branch with either "feature/", "bugfix/", or something similar describing the type of update, and then add a descriptive name such as "bugfix/random\_files_erased".
23 | 4. Add your changes.
24 | * Please try to avoid monolithic commits.
25 | * Code must follow the [Javascript Standard Style](https://standardjs.com/).
26 | * Your code must pass eslint filters to be able to commit.
27 | 5. Make sure your master branch is [in sync/up-to-date with the original](https://help.github.com/articles/syncing-a-fork/).
28 | 6. Before submitting a pull request, merge in your synced master branch with your current branch and resolve any conflicts.
29 | 7. Once all conflicts are resolved, submit a pull request to the origin master branch.
30 | 8. Your pull request will be reviewed along with change requests or comments.
31 | 9. After all requests are complete, your pull request will be merged in.
32 | 10. Celebrate! :tada:
33 |
34 | **NOTE**: Don't forget to [update the docs](https://resthapi.com/docs/quick-start.html)! 😉
35 |
36 | ### This is my first Pull Request, where can I learn how to contribute?
37 |
38 | You can take this free course:
39 | [_How to Contribute to an Open Source Project on GitHub_](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
40 |
--------------------------------------------------------------------------------
/tests/e2e/test-scenarios/scenario-3/models/user.model.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const Boom = require('@hapi/boom')
4 |
5 | module.exports = function(mongoose) {
6 | const modelName = 'user'
7 | const Types = mongoose.Schema.Types
8 | const Schema = new mongoose.Schema(
9 | {
10 | email: {
11 | type: Types.String,
12 | unique: true
13 | },
14 | password: {
15 | type: Types.String,
16 | required: true,
17 | exclude: true,
18 | allowOnUpdate: false
19 | },
20 | firstName: {
21 | type: Types.String
22 | },
23 | lastName: {
24 | type: Types.String
25 | },
26 | title: {
27 | type: Types.ObjectId,
28 | ref: 'role'
29 | },
30 | profile: {
31 | type: Types.ObjectId,
32 | ref: 'userProfile'
33 | }
34 | },
35 | { collection: modelName }
36 | )
37 |
38 | Schema.statics = {
39 | collectionName: modelName,
40 | routeOptions: {
41 | associations: {
42 | profile: {
43 | type: 'ONE_ONE',
44 | model: 'userProfile',
45 | duplicate: {
46 | field: 'status',
47 | as: 'state'
48 | }
49 | },
50 | title: {
51 | type: 'MANY_ONE',
52 | model: 'role',
53 | duplicate: [
54 | {
55 | field: 'name'
56 | },
57 | {
58 | field: 'description',
59 | as: 'summary'
60 | },
61 | {
62 | field: 'companyName',
63 | as: 'businessName'
64 | }
65 | ]
66 | },
67 | permissions: {
68 | type: 'MANY_MANY',
69 | alias: 'permissions',
70 | model: 'permission',
71 | linkingModel: 'user_permission'
72 | },
73 | tags: {
74 | type: '_MANY',
75 | model: 'hashtag'
76 | }
77 | },
78 | update: {
79 | pre: function(_id, payload, request, Log) {
80 | if (payload.email === 'error@user.com') {
81 | throw Boom.badRequest('user error')
82 | }
83 |
84 | return payload
85 | }
86 | }
87 | }
88 | }
89 |
90 | return Schema
91 | }
92 |
--------------------------------------------------------------------------------
/website/pages/en/help.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require('react')
9 |
10 | const CompLibrary = require('../../core/CompLibrary.js')
11 | const Container = CompLibrary.Container
12 | const GridBlock = CompLibrary.GridBlock
13 |
14 | const siteConfig = require(process.cwd() + '/siteConfig.js')
15 |
16 | function docUrl(doc, language) {
17 | return siteConfig.baseUrl + 'docs/' + (language ? language + '/' : '') + doc
18 | }
19 |
20 | class Help extends React.Component {
21 | render() {
22 | let language = this.props.language || ''
23 | const supportLinks = [
24 | {
25 | content: `Learn more about rest-hapi using the [documentation on this site.](${docUrl(
26 | 'quick-start.html',
27 | null
28 | )})`,
29 | title: 'Browse the docs'
30 | },
31 | {
32 | content:
33 | 'Ask questions about the documentation and project. Join the conversation on [gitter](https://gitter.im/rest-hapi/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)!',
34 | title: 'Gitter'
35 | },
36 | {
37 | content:
38 | 'You can follow and contact us on [Twitter](https://twitter.com/resthapi).',
39 | title: 'Twitter'
40 | },
41 | {
42 | content:
43 | 'At our [GitHub repo](https://github.com/JKHeadley/rest-hapi) Browse and submit [issues](https://github.com/JKHeadley/rest-hapi/issues) or [pull requests](https://github.com/JKHeadley/rest-hapi/pulls) for bugs you find or any new features you may want implemented. Be sure to also check out our [contributing information](https://github.com/JKHeadley/rest-hapi/blob/master/CONTRIBUTING.md).',
44 | title: 'GitHub'
45 | }
46 | ]
47 |
48 | return (
49 | 56 | If you need help with rest-hapi, you can try one of the mechanisms 57 | below. 58 |
59 |