feat: introduce api-settings-manager package

webiny · May 28, 2020 · cbb2508 · cbb2508
1 parent 3c45e8e
commit cbb2508
Show file tree

Hide file tree

Showing 32 changed files with 308 additions and 17 deletions.
diff --git a/package.json b/package.json
@@ -5,11 +5,12 @@
       "packages/*",
       "sample-project/apps/*",
       "sample-project/api/apolloGateway",
+      "sample-project/api/settingsManager",
       "sample-project/api/databaseProxy",
       "sample-project/api/files/*",
       "sample-project/api/formBuilder",
       "sample-project/api/cms/*",
-      "sample-project/api/i18n",
+      "sample-project/api/i18n/*",
       "sample-project/api/pageBuilder",
       "sample-project/api/security/*"
     ],

diff --git a/packages/api-cookie-policy/package.json b/packages/api-cookie-policy/package.json
@@ -24,7 +24,8 @@
     "@babel/core": "^7.5.5",
     "@babel/preset-env": "^7.5.5",
     "@babel/preset-typescript": "^7.8.3",
-    "@svgr/webpack": "^4.3.2"
+    "@svgr/webpack": "^4.3.2",
+    "@webiny/api-settings-manager": "^4.0.0-beta.1"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/api-cookie-policy/src/index.ts b/packages/api-cookie-policy/src/index.ts
@@ -1,7 +1,11 @@
 import gql from "graphql-tag";
-import { emptyResolver, resolveGetSettings, resolveUpdateSettings } from "@webiny/commodo-graphql";
+import { emptyResolver, ErrorResponse, resolveUpdateSettings } from "@webiny/commodo-graphql";
 import { hasScope } from "@webiny/api-security";
 import cookiePolicySettings from "./cookiePolicySettings.model";
+import { Context } from "@webiny/graphql/types";
+import { Context as SettingsManagerContext } from "@webiny/api-settings-manager/types";
+
+type SettingsContext = Context & SettingsManagerContext;
 
 export default () => [
     {
@@ -102,7 +106,14 @@ export default () => [
                     cookiePolicy: emptyResolver
                 },
                 CookiePolicyQuery: {
-                    getSettings: resolveGetSettings(({ models }) => models.CookiePolicySettings)
+                    getSettings: async (_, args, context: SettingsContext) => {
+                        try {
+                            const data = await context.settingsManager.getSettings("cookie-policy");
+                            return { data };
+                        } catch (err) {
+                            return new ErrorResponse(err);
+                        }
+                    }
                 },
                 CookiePolicyMutation: {
                     updateSettings: hasScope("pb:settings")(

diff --git a/packages/api-cookie-policy/tsconfig.build.json b/packages/api-cookie-policy/tsconfig.build.json
@@ -4,6 +4,7 @@
   "exclude": [
     "node_modules",
     "../api-security",
+    "../api-settings-manager",
     "../commodo",
     "../commodo-graphql",
     "../validation"
@@ -15,6 +16,7 @@
   },
   "references": [
     { "path": "../api-security/tsconfig.build.json" },
+    { "path": "../api-settings-manager/tsconfig.build.json" },
     { "path": "../commodo-graphql/tsconfig.build.json" },
     { "path": "../validation/tsconfig.build.json" }
   ]

diff --git a/packages/api-cookie-policy/tsconfig.json b/packages/api-cookie-policy/tsconfig.json
@@ -2,6 +2,7 @@
   "extends": "../../tsconfig",
   "references": [
     { "path": "../api-security" },
+    { "path": "../api-settings-manager" },
     { "path": "../commodo" },
     { "path": "../commodo-graphql" },
     { "path": "../validation" }

diff --git a/packages/api-form-builder/package.json b/packages/api-form-builder/package.json
@@ -39,6 +39,7 @@
     "@babel/preset-env": "^7.5.5",
     "@babel/preset-typescript": "^7.8.3",
     "@webiny/api-plugin-commodo-db-proxy": "^4.0.0-beta.1",
+    "@webiny/api-settings-manager": "^4.0.0-beta.1",
     "flow-copy-source": "^2.0.2"
   },
   "publishConfig": {

diff --git a/packages/api-form-builder/src/plugins/graphql/formsSettings.ts b/packages/api-form-builder/src/plugins/graphql/formsSettings.ts
@@ -1,5 +1,9 @@
-import { resolveUpdateSettings, resolveGetSettings } from "@webiny/commodo-graphql";
+import { resolveUpdateSettings, ErrorResponse } from "@webiny/commodo-graphql";
 import { hasScope } from "@webiny/api-security";
+import { Context } from "@webiny/graphql/types";
+import { Context as SettingsManagerContext } from "@webiny/api-settings-manager/types";
+
+type SettingsContext = Context & SettingsManagerContext;
 
 const getFormSettings = ctx => ctx.models.FormSettings;
 
@@ -43,7 +47,14 @@ export default {
     `,
     resolvers: {
         FormsQuery: {
-            getSettings: hasScope("forms:settings")(resolveGetSettings(getFormSettings))
+            getSettings: hasScope("forms:settings")(async (_, args, context: SettingsContext) => {
+                try {
+                    const data = await context.settingsManager.getSettings("forms");
+                    return { data };
+                } catch (err) {
+                    return new ErrorResponse(err);
+                }
+            })
         },
         FormsMutation: {
             updateSettings: hasScope("forms:settings")(resolveUpdateSettings(getFormSettings))

diff --git a/packages/api-form-builder/tsconfig.build.json b/packages/api-form-builder/tsconfig.build.json
@@ -6,6 +6,7 @@
     "../graphql",
     "../api-i18n",
     "../api-security",
+    "../api-settings-manager",
     "../commodo",
     "../commodo-graphql",
     "../handler-ssr",
@@ -20,6 +21,7 @@
     { "path": "../graphql/tsconfig.build.json" },
     { "path": "../api-i18n/tsconfig.build.json" },
     { "path": "../api-security/tsconfig.build.json" },
+    { "path": "../api-settings-manager/tsconfig.build.json" },
     { "path": "../commodo-graphql/tsconfig.build.json" },
     { "path": "../handler-ssr/tsconfig.build.json" },
     { "path": "../validation/tsconfig.build.json" }

diff --git a/packages/api-form-builder/tsconfig.json b/packages/api-form-builder/tsconfig.json
@@ -4,6 +4,7 @@
     { "path": "../graphql" },
     { "path": "../api-i18n" },
     { "path": "../api-security" },
+    { "path": "../api-settings-manager" },
     { "path": "../commodo" },
     { "path": "../commodo-graphql" },
     { "path": "../handler-ssr" },

diff --git a/packages/api-google-tag-manager/package.json b/packages/api-google-tag-manager/package.json
@@ -23,6 +23,7 @@
     "@babel/core": "^7.5.5",
     "@babel/preset-env": "^7.5.5",
     "@babel/preset-typescript": "^7.8.3",
+    "@webiny/api-settings-manager": "^4.0.0-beta.1",
     "@svgr/webpack": "^4.3.2"
   },
   "publishConfig": {

diff --git a/packages/api-google-tag-manager/src/index.ts b/packages/api-google-tag-manager/src/index.ts
@@ -1,7 +1,11 @@
 import gql from "graphql-tag";
-import { emptyResolver, resolveUpdateSettings, resolveGetSettings } from "@webiny/commodo-graphql";
+import { emptyResolver, resolveUpdateSettings, ErrorResponse } from "@webiny/commodo-graphql";
 import { hasScope } from "@webiny/api-security";
 import googleTagManagerSettings from "./googleTagManagerSettings.model";
+import { Context } from "@webiny/graphql/types";
+import { Context as SettingsManagerContext } from "@webiny/api-settings-manager/types";
+
+type SettingsContext = Context & SettingsManagerContext;
 
 export default () => [
     {
@@ -63,7 +67,14 @@ export default () => [
                     googleTagManager: emptyResolver
                 },
                 GtmQuery: {
-                    getSettings: resolveGetSettings(({ models }) => models.GoogleTagManagerSettings)
+                    getSettings: async (_, args, context: SettingsContext) => {
+                        try {
+                            const data = await context.settingsManager.getSettings("google-tag-manager");
+                            return { data };
+                        } catch (err) {
+                            return new ErrorResponse(err);
+                        }
+                    }
                 },
                 GtmMutation: {
                     updateSettings: hasScope("pb:settings")(

diff --git a/packages/api-google-tag-manager/tsconfig.build.json b/packages/api-google-tag-manager/tsconfig.build.json
@@ -1,14 +1,22 @@
 {
   "extends": "../../tsconfig.build.json",
   "include": ["./src"],
-  "exclude": ["node_modules", "./dist", "../api-security", "../commodo", "../commodo-graphql"],
+  "exclude": [
+    "node_modules",
+    "./dist",
+    "../api-security",
+    "../api-settings-manager",
+    "../commodo",
+    "../commodo-graphql"
+  ],
   "compilerOptions": {
     "rootDir": "./src",
     "outDir": "./dist",
     "declarationDir": "./dist"
   },
   "references": [
     { "path": "../api-security/tsconfig.build.json" },
+    { "path": "../api-settings-manager/tsconfig.build.json" },
     { "path": "../commodo-graphql/tsconfig.build.json" }
   ]
 }
diff --git a/packages/api-google-tag-manager/tsconfig.json b/packages/api-google-tag-manager/tsconfig.json
@@ -2,6 +2,7 @@
   "extends": "../../tsconfig",
   "references": [
     { "path": "../api-security" },
+    { "path": "../api-settings-manager" },
     { "path": "../commodo" },
     { "path": "../commodo-graphql" }
   ]

diff --git a/packages/api-mailchimp/package.json b/packages/api-mailchimp/package.json
@@ -27,6 +27,7 @@
     "@babel/preset-react": "^7.0.0",
     "@babel/preset-typescript": "^7.8.3",
     "@svgr/webpack": "^4.3.2",
+    "@webiny/api-settings-manager": "^4.0.0-beta.1",
     "apollo-server-lambda": "^2.9.6"
   },
   "publishConfig": {

diff --git a/packages/api-mailchimp/src/index.ts b/packages/api-mailchimp/src/index.ts
@@ -1,11 +1,14 @@
 import gql from "graphql-tag";
-import { emptyResolver, resolveGetSettings, resolveUpdateSettings } from "@webiny/commodo-graphql";
+import { emptyResolver, resolveUpdateSettings } from "@webiny/commodo-graphql";
 import { ListErrorResponse, ListResponse, ErrorResponse } from "@webiny/graphql";
 import { hasScope } from "@webiny/api-security";
 import mailchimpSettings from "./mailchimpSettings.model";
 import MailchimpApi from "./MailchimpApi";
 import { get } from "lodash";
-import { Context } from "@webiny/graphql/types";
+import { Context, ContextPlugin, GraphQLSchemaPlugin } from "@webiny/graphql/types";
+import { Context as SettingsManagerContext } from "@webiny/api-settings-manager/types";
+
+type SettingsContext = Context & SettingsManagerContext;
 
 export default () => [
     {
@@ -14,7 +17,7 @@ export default () => [
         apply({ models }) {
             models.MailchimpSettings = mailchimpSettings({ createBase: models.createBase });
         }
-    },
+    } as ContextPlugin,
     {
         name: "graphql-schema-mailchimp",
         type: "graphql-schema",
@@ -124,7 +127,14 @@ export default () => [
                         }
                     },
                     getSettings: hasScope("pb:settings")(
-                        resolveGetSettings(({ models }) => models.MailchimpSettings)
+                        async (_, args, context: SettingsContext) => {
+                            try {
+                                const data = await context.settingsManager.getSettings("mailchimp");
+                                return { data };
+                            } catch (err) {
+                                return new ErrorResponse(err);
+                            }
+                        }
                     )
                 },
                 MailchimpMutation: {
@@ -180,5 +190,5 @@ export default () => [
                 }
             }
         }
-    }
+    } as GraphQLSchemaPlugin
 ];
diff --git a/packages/api-mailchimp/tsconfig.build.json b/packages/api-mailchimp/tsconfig.build.json
@@ -1,7 +1,15 @@
 {
   "extends": "../../tsconfig.build.json",
   "include": ["./src"],
-  "exclude": ["node_modules", "./dist", "../graphql", "../api-security", "../commodo", "../commodo-graphql"],
+  "exclude": [
+    "node_modules",
+    "./dist",
+    "../graphql",
+    "../api-security",
+    "../api-settings-manager",
+    "../commodo",
+    "../commodo-graphql"
+  ],
   "compilerOptions": {
     "rootDir": "./src",
     "outDir": "./dist",
@@ -10,6 +18,7 @@
   "references": [
     { "path": "../graphql/tsconfig.build.json" },
     { "path": "../api-security/tsconfig.build.json" },
+    { "path": "../api-settings-manager/tsconfig.build.json" },
     { "path": "../commodo-graphql/tsconfig.build.json" }
   ]
 }
diff --git a/packages/api-mailchimp/tsconfig.json b/packages/api-mailchimp/tsconfig.json
@@ -3,6 +3,7 @@
   "references": [
     { "path": "../graphql" },
     { "path": "../api-security" },
+    { "path": "../api-settings-manager" },
     { "path": "../commodo" },
     { "path": "../commodo-graphql" }
   ]

diff --git a/packages/api-page-builder/package.json b/packages/api-page-builder/package.json
@@ -46,6 +46,7 @@
     "@babel/plugin-proposal-export-default-from": "^7.5.2",
     "@babel/preset-env": "^7.5.5",
     "@babel/preset-typescript": "^7.8.3",
+    "@webiny/api-settings-manager": "^4.0.0-beta.1",
     "flow-copy-source": "^2.0.2"
   },
   "publishConfig": {

diff --git a/packages/api-page-builder/src/plugins/graphql/Settings.ts b/packages/api-page-builder/src/plugins/graphql/Settings.ts
@@ -1,4 +1,8 @@
-import { resolveUpdateSettings, resolveGetSettings } from "@webiny/commodo-graphql";
+import { resolveUpdateSettings, ErrorResponse } from "@webiny/commodo-graphql";
+import { Context } from "@webiny/graphql/types";
+import { Context as SettingsManagerContext } from "@webiny/api-settings-manager/types";
+
+type SettingsContext = Context & SettingsManagerContext;
 
 export default {
     name: "graphql-schema-settings-page-builder",
@@ -81,7 +85,14 @@ export default {
     `,
     resolvers: {
         PbQuery: {
-            getSettings: resolveGetSettings(ctx => ctx.models.PbSettings)
+            getSettings: async (_, args, context: SettingsContext) => {
+                try {
+                    const data = await context.settingsManager.getSettings("page-builder");
+                    return { data };
+                } catch (err) {
+                    return new ErrorResponse(err);
+                }
+            }
         },
         PbMutation: {
             updateSettings: resolveUpdateSettings(ctx => ctx.models.PbSettings)

diff --git a/packages/api-page-builder/tsconfig.build.json b/packages/api-page-builder/tsconfig.build.json
@@ -5,6 +5,7 @@
     "node_modules",
     "../graphql",
     "../api-security",
+    "../api-settings-manager",
     "../commodo",
     "../commodo-graphql",
     "../handler-ssr",
@@ -18,6 +19,7 @@
   "references": [
     { "path": "../graphql/tsconfig.build.json" },
     { "path": "../api-security/tsconfig.build.json" },
+    { "path": "../api-settings-manager/tsconfig.build.json" },
     { "path": "../commodo-graphql/tsconfig.build.json" },
     { "path": "../handler-ssr/tsconfig.build.json" },
     { "path": "../validation/tsconfig.build.json" }

diff --git a/packages/api-page-builder/tsconfig.json b/packages/api-page-builder/tsconfig.json
@@ -3,6 +3,7 @@
   "references": [
     { "path": "../graphql" },
     { "path": "../api-security" },
+    { "path": "../api-settings-manager" },
     { "path": "../commodo" },
     { "path": "../commodo-graphql" },
     { "path": "../handler-ssr" },

diff --git a/packages/api-settings-manager/.babelrc.js b/packages/api-settings-manager/.babelrc.js
@@ -0,0 +1 @@
+module.exports = require("../../.babel.node");
diff --git a/packages/api-settings-manager/LICENSE b/packages/api-settings-manager/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/api-settings-manager/README.md b/packages/api-settings-manager/README.md
@@ -0,0 +1 @@
+# @webiny/api-settings-manager