@webresto/graphql 1.3.0

package/package.json

@@ -0,0 +1,47 @@
+{
+  "author": {
+    "name": "Webresto"
+  },
+  "bundleDependencies": false,
+  "dependencies": {
+    "apollo-fetch": "^0.7.0",
+    "apollo-server": "^2.25.2",
+    "dataloader": "^2.0.0",
+    "graphql": "^15.5.0",
+    "waterline-criteria": "^2.0.0"
+  },
+  "deprecated": false,
+  "description": "Webresto graphql api",
+  "directories": {
+    "doc": "docs",
+    "lib": "lib"
+  },
+  "keywords": [
+    "iiko",
+    "sails",
+    "resto",
+    "graphql"
+  ],
+  "license": "ISC",
+  "main": "index.js",
+  "name": "@webresto/graphql",
+  "repository": {
+    "type": "git",
+    "url": "http://git.42team.org/webresto/graphql.git"
+  },
+  "sails": {
+    "isHook": true,
+    "hookName": "restographql"
+  },
+  "scripts": {
+    "gendoc": "apidoc -o apidoc/ && apidoc-markdown2 -p apidoc -o docs/api.md",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "test:js": "mocha test/_bootstrap.js test/**/*.test.js",
+    "test:init": "cd ./test/fixtures/v0.12-app && npm i --no-package-lock --prefix ./ && cd -"
+  },
+  "version": "1.3.0",
+  "devDependencies": {
+    "@types/node": "^14.14.35",
+    "@webresto/core": "^1.0.0"
+  }
+}

package/readme.md

@@ -0,0 +1,258 @@
+# Order
+Корзина
+-  Запросить новую корзину getNewOrder
+-  Подписатся на изменения корзины order(id: String)
+-  Добавить блюдо addToOrder
+-  Изменить количество orderSetAmount
+-  Удалить блюдо removeFromOrder
+
+# Menu
+- Получение блюд dish, dishes (без параметров вернет все блюда)
+- Получение групп group, groups (без параметров вернет корневые группы)
+
+# Checkout
+- Проверка checkOrder
+- Заказ sendOrder
+
+# Subscription
+- сообщения и ошибки - message
+- переходы и экшены - action
+- измененная корзина  - order
+
+# criteria: Json
+query запросы waterline ORM
+https://0.12.sailsjs.com/documentation/concepts/models-and-orm/query-language#?criteria-modifiers
+```js
+// поиск по полю id
+criteria = {id: "some-unique-id"}
+// можно перечислить массив (условие OR), вернутся записи имеющие slug1 или slug2
+criteria = {slug: ["slag1", "slag2"]}
+// перечисление полей равносильно условию AND, вернутся записи с id = "some-unique-id" AND slug = "slug1"
+criteria = {id: "some-unique-id", slug: "slug1"}
+
+
+// дополнительный условия
+'lessThan'
+'lessThanOrEqual'
+'greaterThan'
+'greaterThanOrEqual'
+'not'
+'like'
+'contains'
+'startsWith'
+'endsWith'
+// пример
+criteria = {price: {lessThan: 100}}
+
+// сортировка и пагинация. Чтобы использовать сортировку или лимиты основной запрос нужно поместить в where: {}
+criteria = {
+  where: {price: {lessThan: 100}},
+  skip: 20,
+  limit: 10,
+  sort: 'price DESC'
+}
+
+// graphql аналоги запросов для LF :
+/*
+1.  https://api.lifenadym.com/navigation
+query{
+  navigation{
+    ...
+  }
+}
+2. https://api.lifenadym.com/page/kafe
+query{
+  pages(criteria: {path: "kafe"}}){
+    ...
+  }
+}
+3.  https://api.lifenadym.com/api/0.5/menu?groupSlug=dostavka
+query{
+  groups(criteria: {slug: "dostavka"}){
+    ...
+  }
+}
+
+4. Запрос по поду с json
+promotions(criteria: {section: {contains:"dostavka"}})
+*/
+```
+
+
+# Backend helpers
+- sendMessage(orderId, message) - отправление собщения через подписку PubSub
+- sendAction(orderId, action)
+- addModel(modelName) - генерирует тип из модели. Не использовать! при автоматической генерации всех моделей через addAllSailsModels
+- addType(string) - добавить тип в виде готовой схемы
+- addResolvers - добавить resolvers
+- getSchema - возвращает сгенерированную схему и соедененные резолверсы
+- addToBlackList
+- addCustomField
+- addToReplaceList
+- addAllSailsModels - Генерирует схему по sails моделям.
+
+# Пример использования
+## Использование хука
+Хук должен находиться в папке node_modules.
+
+Код можно вставить в config/bootstrap.js или в afterHook при оспользовании в друших хуках. Главное чтобы код был выполнен до sails lifted, т.к. генерация GraphQL схемы происходит на этом событии.
+
+Хук автоматически сканирует и добавляет в схему все модели проекта, находящиеся в sails.models
+
+Автоматически добавляются резолверсы в папке проекта api/resolvers
+
+
+```typescript
+// импортируем хелпер
+import * as helper from '@webresto/graphql'
+// доп импорты
+const path = require('path');
+
+// добавляем resolvers из указанной папки
+helper.addDirResolvers(path.resolve(__dirname, './resolvers'));
+// все модели sails будут автоматически занесены в схему GraphQL
+
+// Игнорируем при генерации поле dontShow модели Picture
+helper.addToBlackList(["Picture.dontShow"]);
+
+// для простых задач выше перечисленного достаточно. Ниже описанны дополнительные возможности.
+
+// Добавляем резолверс вручную
+helper.addResolvers(
+  // структура резолверса
+  {
+    // Название основного элемента, обычно Query, Mutation, Subscription
+    Query: {
+      // имя должно совпадать с именем метода в GraphQL схеме ниже
+      sayHi: {
+          // описание метода в GraphQL схеме. При генерации будет полностью перенесено в неизменном виде
+          def: 'sayHi: String',
+          // функция резолвер. Стандартный резолвер GraphQL, после генерации схемы будет расположен в переменной sayHi. Для подписок может быть объектом, а не функцией
+          fn: function (parent, args, context){
+              return "Hi there! Welcome to GraphQL!";
+          },
+      }
+    }
+  }
+);
+
+// пример добавления типов в схему. Для существующих типов обязательно расширять тип, то есть писать extend type. Такие типы как Query, Mutation, Subscription определены поумолчанию, их обязательно расширять. Если добавляется метод, к нему обязательно нужно добавить резолвер.
+helper.addType(`extend type Query {
+            sayAnotherWord: String
+          }
+        `);
+
+```
+
+пример резолверса
+
+```typescript
+export default {
+  // основные типы Query, Mutation, Subscription будут записаны в соответствующий тип
+  Query: {
+    dish: {
+      def: 'dish(id: String): Dish',
+      fn: async function (parent, args, context, info) {
+        return await Dish.findOne({id: args.id});
+      }
+    }
+  }
+  Subscription: {
+    dish: {
+      def: 'dish: Dish',
+      // для типа Subscription резолвер должен содержать функции subscribe & resolve
+      fn: {
+        subscribe: function (parent, args, context, info) {
+          return context.pubsub.asyncIterator("dish-changed");
+        },
+        resolve: payload => {
+          return payload;
+        }
+      }
+    }
+  },
+
+  // пример резолверса полей типа Dish
+  Dish: {
+    // функция по умолчанию, можно не писать. Можно заменить любой логикой, главное что бы возвращаемый тип соответствовал схеме
+    filed1: (parent, args, context, info) => parent.field1
+  }
+}
+```
+
+
+
+
+## Black List
+Варианты:
+1. ["Order.field"] - исключает поле field в модели Order
+2. ["Order"] - исключает модель Order полностью
+3. ["field] - исключает поле field из всех моделей
+
+### example
+    ```
+    grqlHelper.addToBlackList(["createdAt", "updatedAt"]);
+    ```
+    исключает поля "createdAt", "updatedAt" из автоматической генерации
+
+## addResolvers
+Пример добавления:
+- def - описание метода для graphQl schema. Попадет в основные типы Query, Mutation, Subscription. Для примера ниже будет "type Query { orderDish(id: Int!): OrderDish }"
+- fn - метод или объект. Попадет в Resolvers согласно структуре, для примера ниже будет - Resolvers = {Query:{orderDish: fn}}
+- При вызове соеденяет объекты: _.merge(oldResolvers, newResolvers);
+```
+const resolvers = {
+    Query: {
+        orderDish: {
+            def: 'orderDish(id: Int!): OrderDish',
+            fn: async function (parent, args, context) {
+                return await OrderDish.findOne({id: args.id});
+            }
+        }
+    }
+}
+```
+
+## addToReplaceList
+addToReplaceList(path, field)
+### example
+Замена поля и его типизация. Если добавляется новый тип, его необходимо описать, иначе вылетит исключение graphql
+```
+grqlHelper.addToReplaceList("Dish.image", "image: [Image]");
+grqlHelper.addType("scalar Image");
+```
+
+## addCustomField
+Добавляет поле в указанную модель. Нет проверки на совпадение полей. Если поля совпадут graphql не запустится.
+```
+grqlHelper.addCustomField("Order", "customField: String")
+```
+Результат:
+type Order {
+    ...
+    customField: String
+    ...
+}
+
+## setWhiteList
+Добавляет модели в белый лист автогенератора. Можно установить генерацию для query запросов и подписок
+```ts
+/**
+ * Добавляет whiteList
+ * Пример: setWhiteList({
+    page: ['query'],
+    promotion: ['query'],
+    maintenance: ['query', 'subscription']
+  })
+ *
+ * @param list
+ */
+// Пример использования в хуках или проекте
+import * as helper from '@webresto/graphql'
+
+helper.setWhiteList({
+    page: ['query'],
+    promotion: ['query'],
+    maintenance: ['query', 'subscription']
+  })
+```

package/restApi.http

@@ -0,0 +1,11 @@
+@host = http://127.0.0.1:42777
+
+@host2 = https://api.lifenadym.webresto.dev
+
+GET {{host}}/api/0.5/menu
+
+###
+GET {{host2}}/api/0.5/api/getNomenclature
+
+###
+GET {{host}}/api/0.5/menu?groupSlug=sousy

package/src/additionalResolvers.d.ts

@@ -0,0 +1,19 @@
+export declare const additionalResolver: {
+    GroupModifier: {
+        group: (parent: any, args: any, context: any, info: any) => Promise<any>;
+    };
+    Modifier: {
+        dish: (parent: any, args: any, context: any, info: any) => Promise<any>;
+    };
+    OrderModifier: {
+        dish: (parent: any, args: any, context: any, info: any) => Promise<any>;
+        group: (parent: any, args: any) => Promise<any>;
+    };
+    Dish: {
+        parentGroup: (parent: any, args: any, context: any, info: any) => Promise<any>;
+        images: (parent: any, args: any, context: any, info: any) => Promise<any>;
+    };
+    Group: {
+        parentGroup: (parent: any, args: any, context: any, info: any) => Promise<any>;
+    };
+};

package/src/additionalResolvers.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.additionalResolver = void 0;
+const DataLoader = require('dataloader');
+exports.additionalResolver = {
+    GroupModifier: {
+        group: async (parent, args, context, info) => {
+            if (!parent.modifierId)
+                return;
+            if (!context.dataloaders)
+                context.dataloaders = new WeakMap();
+            const dataloaders = context.dataloaders;
+            let dl = dataloaders.get(info.fieldNodes);
+            if (!dl) {
+                dl = new DataLoader(async (ids) => {
+                    const rows = await Group.find({ id: ids });
+                    const sortedInIdsOrder = ids.map(id => rows.find(x => x.id === id));
+                    return sortedInIdsOrder;
+                });
+                dataloaders.set(info.fieldNodes, dl);
+            }
+            return dl.load(parent.modifierId);
+        },
+    },
+    Modifier: {
+        dish: async (parent, args, context, info) => {
+            if (!parent.modifierId)
+                return;
+            if (!context.dataloaders)
+                context.dataloaders = new WeakMap();
+            const dataloaders = context.dataloaders;
+            let dl = dataloaders.get(info.fieldNodes);
+            if (!dl) {
+                dl = new DataLoader(async (ids) => {
+                    const rows = await Dish.find({ id: ids, balance: { "!=": 0 }, isDeleted: false });
+                    const sortedInIdsOrder = ids.map(id => rows.find(x => x.id === id));
+                    return sortedInIdsOrder;
+                });
+                // ложим инстанс дата-лоадера в WeakMap для повторного использования
+                dataloaders.set(info.fieldNodes, dl);
+            }
+            // юзаем метод `load` из нашего дата-лоадера
+            return dl.load(parent.modifierId);
+            // return await Dish.findOne({id: parent.modifierId}).populateAll();
+        }
+    },
+    OrderModifier: {
+        dish: async (parent, args, context, info) => {
+            return (await Dish.find({ id: parent.id, balance: { "!": 0 }, isDeleted: false }).populateAll())[0];
+        },
+        group: async (parent, args) => {
+            return (await Group.find({ id: parent.groupId, isDeleted: false }).populateAll())[0];
+        }
+    },
+    Dish: {
+        parentGroup: async (parent, args, context, info) => {
+            if (!parent.parentGroup)
+                return;
+            if (!context.dataloaders)
+                context.dataloaders = new WeakMap();
+            const dataloaders = context.dataloaders;
+            // need to investigate why getting object instead of string
+            if (typeof parent.parentGroup === "object") {
+                return parent.parentGroup;
+            }
+            let dl = dataloaders.get(info.fieldNodes);
+            if (!dl) {
+                dl = new DataLoader(async (id) => {
+                    return await Group.find(id);
+                });
+                dataloaders.set(info.fieldNodes, dl);
+            }
+            return dl.load(parent.parentGroup);
+        },
+        images: async (parent, args, context, info) => {
+            if (!parent.id)
+                return;
+            if (!context.dataloaders)
+                context.dataloaders = new WeakMap();
+            const dataloaders = context.dataloaders;
+            let dl = dataloaders.get(info.fieldNodes);
+            if (!dl) {
+                dl = new DataLoader(async (ids) => {
+                    const rows = await Dish.find({ id: ids }).populate('images');
+                    const images = ids.map(id => { var _a; return (_a = rows.find(x => x.id === id)) === null || _a === void 0 ? void 0 : _a.images; });
+                    return images;
+                });
+                dataloaders.set(info.fieldNodes, dl);
+            }
+            return dl.load(parent.id);
+        }
+    },
+    Group: {
+        parentGroup: async (parent, args, context, info) => {
+            if (!parent.parentGroup)
+                return;
+            if (!context.dataloaders)
+                context.dataloaders = new WeakMap();
+            const dataloaders = context.dataloaders;
+            // need to investigate why getting object instead of string
+            if (typeof parent.parentGroup === "object") {
+                return parent.parentGroup;
+            }
+            let dl = dataloaders.get(info.fieldNodes);
+            if (!dl) {
+                dl = new DataLoader(async (id) => {
+                    return await Group.find(id);
+                });
+                dataloaders.set(info.fieldNodes, dl);
+            }
+            return dl.load(parent.parentGroup);
+        }
+    }
+};

package/src/additionalResolvers.ts

@@ -0,0 +1,111 @@
+const DataLoader = require('dataloader');
+
+export const additionalResolver = {
+  GroupModifier: {
+    group: async (parent, args, context, info) => {
+      if (!parent.modifierId) return;
+      if (!context.dataloaders) context.dataloaders = new WeakMap();
+      const dataloaders = context.dataloaders;
+
+      let dl = dataloaders.get(info.fieldNodes);
+      if (!dl) {
+        dl = new DataLoader(async (ids: any) => {
+          const rows = await Group.find({id: ids});
+          const sortedInIdsOrder = ids.map(id => rows.find(x => x.id === id));
+          return sortedInIdsOrder;
+        });
+        dataloaders.set(info.fieldNodes, dl);
+      }
+      return dl.load(parent.modifierId);
+    },
+  },
+  Modifier: {
+    dish: async (parent, args, context, info) => {
+      if (!parent.modifierId) return;
+      if (!context.dataloaders) context.dataloaders = new WeakMap();
+      const dataloaders = context.dataloaders;
+
+      let dl = dataloaders.get(info.fieldNodes);
+      if (!dl) {
+        dl = new DataLoader(async (ids: any) => {
+          const rows = await Dish.find({id: ids, balance: { "!=": 0 }, isDeleted: false});
+          const sortedInIdsOrder = ids.map(id => rows.find(x => x.id === id));
+          return sortedInIdsOrder;
+        });
+        // ложим инстанс дата-лоадера в WeakMap для повторного использования
+        dataloaders.set(info.fieldNodes, dl);
+      }
+      // юзаем метод `load` из нашего дата-лоадера
+      return dl.load(parent.modifierId);
+      // return await Dish.findOne({id: parent.modifierId}).populateAll();
+    }
+  },
+
+  OrderModifier: {
+    dish: async (parent, args, context, info) => {
+      return (await Dish.find({id: parent.id, balance: { "!": 0 }, isDeleted: false}).populateAll())[0];
+    },
+    group: async (parent, args) => {
+      return (await Group.find({id: parent.groupId, isDeleted: false}).populateAll())[0];
+    }
+  },
+
+  Dish: {
+    parentGroup: async (parent, args, context, info) => {
+      if (!parent.parentGroup) return;
+      if (!context.dataloaders) context.dataloaders = new WeakMap();
+      const dataloaders = context.dataloaders;
+
+      // need to investigate why getting object instead of string
+      if (typeof parent.parentGroup === "object") {
+        return parent.parentGroup;
+      }
+
+      let dl = dataloaders.get(info.fieldNodes);
+      if (!dl) {
+        dl = new DataLoader(async (id: any) => {
+          return await Group.find(id);
+        });
+        dataloaders.set(info.fieldNodes, dl);
+      }
+      return dl.load(parent.parentGroup);
+    },
+    images: async (parent, args, context, info) => {
+      if (!parent.id) return;
+      if (!context.dataloaders) context.dataloaders = new WeakMap();
+      const dataloaders = context.dataloaders;
+
+      let dl = dataloaders.get(info.fieldNodes);
+      if (!dl) {
+        dl = new DataLoader(async (ids: any) => {
+          const rows = await Dish.find({id: ids}).populate('images');
+          const images = ids.map(id => rows.find(x => x.id === id)?.images);
+          return images;
+        });
+        dataloaders.set(info.fieldNodes, dl);
+      }
+      return dl.load(parent.id);
+    }
+  },
+  Group: {
+    parentGroup: async (parent, args, context, info) => {
+      if (!parent.parentGroup) return;
+      if (!context.dataloaders) context.dataloaders = new WeakMap();
+      const dataloaders = context.dataloaders;
+
+      // need to investigate why getting object instead of string
+      if (typeof parent.parentGroup === "object") {
+        return parent.parentGroup;
+      }
+
+      let dl = dataloaders.get(info.fieldNodes);
+      if (!dl) {
+        dl = new DataLoader(async (id: any) => {
+          return await Group.find(id);
+        });
+        dataloaders.set(info.fieldNodes, dl);
+      }
+      return dl.load(parent.parentGroup);
+    }
+  }
+}

package/src/graphql.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    getPubsub: () => any;
+    getServer: () => any;
+    addAdditionalResolver: (resolver: any) => void;
+    init: () => Promise<any>;
+};
+export default _default;