@ldsg/graphql-resolver 0.1.1

package/README.md

@@ -0,0 +1,85 @@
+# @ldsg/graphql-resolver
+
+GraphQL Resolver 资源模块，用于向 GraphQL schema 添加单个 resolver。
+
+## 功能
+
+- 支持向 Query/Mutation 添加 resolver
+- 支持向 Object 类型添加关系（relation）
+- 支持使用 jsonata 表达式配置 prepareArgs
+- 支持 projection 配置
+
+## 使用示例
+
+### 添加 Query/Mutation resolver
+
+```typescript
+// Query.userFindById
+{
+  typeName: 'Query',
+  fieldName: 'userFindById',
+  objectTypeName: 'User',
+  resolverName: 'findById'
+}
+
+// Mutation.userCreateOne
+{
+  typeName: 'Mutation',
+  fieldName: 'userCreateOne',
+  objectTypeName: 'User',
+  resolverName: 'createOne'
+}
+```
+
+### 添加 Relation
+
+```typescript
+// User.friends
+{
+  typeName: 'User',
+  fieldName: 'friends',
+  objectTypeName: 'User',
+  resolverName: 'dataLoaderMany',
+  prepareArgs: '{ _ids: friendsIds }',
+  projection: { friendsIds: 1 }
+}
+
+// User.adultFriendsWithSameGender
+{
+  typeName: 'User',
+  fieldName: 'adultFriendsWithSameGender',
+  objectTypeName: 'User',
+  resolverName: 'findMany',
+  prepareArgs: '{ filter: { _id: { $in: friendsIds }, age: { $gt: 21 }, gender: gender }, limit: 10 }',
+  projection: { friendsIds: 1, gender: 1 }
+}
+```
+
+### Form resolver
+
+```typescript
+// Mutation.submitUserForm
+{
+  typeName: 'Mutation',
+  fieldName: 'submitUserForm',
+  objectTypeName: 'UserForm',
+  resolverName: 'submit'
+}
+```
+
+## 配置项
+
+| 字段 | 类型 | 描述 |
+|-------|------|------|
+| typeName | string | 添加到的类型名称：'Query'、'Mutation' 或 Object 类型名称 |
+| fieldName | string | 字段名称 |
+| description? | string | 字段描述（可选） |
+| objectTypeName | string | resolver 所属的对象类型名称 |
+| resolverName | string | resolver 方法名称 |
+| prepareArgs? | string | jsonata 表达式，用于 prepareArgs（可选） |
+| projection? | object | projection 配置（可选） |
+
+## 相关
+
+- [@ldsg/graphql-resolvers](../graphql-resolvers/README.md)
+- [@ldsg/graphql](../../libs/graphql/README.md)

package/dist/constants.d.ts

@@ -0,0 +1,18 @@
+import { HandlerSpecificResourceSettings } from '@ldsg/handler';
+import { ResourceDefinitionSpecificResourceSettings } from '@ldsg/resource-definition';
+import { GeneralResourceSettings } from '@ldsg/types';
+/**
+ * Instantiate Resource Handler General Resource Settings
+ * 实例化资源处理程序普通资源配置
+ */
+export declare const INSTANTIATE_RESOURCE_HANDLER_GENERAL_RESOURCE_SETTINGS: GeneralResourceSettings;
+/**
+ * Instantiate Resource Handler Specific Resource Settings
+
+ * 实例化资源处理程序特殊资源配置
+ * 框架通过此实例化此资源
+ */
+export declare const INSTANTIATE_RESOURCE_HANDLER_SPECIFIC_RESOURCE_SETTINGS: HandlerSpecificResourceSettings;
+export declare const RESOURCE_DEFINITION_GENERAL_RESOURCE_SETTINGS: GeneralResourceSettings;
+export declare const RESOURCE_DEFINITION_SPECIFIC_RESOURCE_SETTINGS: ResourceDefinitionSpecificResourceSettings;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,0CAA0C,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,sDAAsD,EAAE,uBAGpE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uDAAuD,EAAE,+BAOrE,CAAC;AAEF,eAAO,MAAM,6CAA6C,EAAE,uBAG3D,CAAC;AAEF,eAAO,MAAM,8CAA8C,EAAE,0CAE5D,CAAC"}

package/dist/constants.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RESOURCE_DEFINITION_SPECIFIC_RESOURCE_SETTINGS = exports.RESOURCE_DEFINITION_GENERAL_RESOURCE_SETTINGS = exports.INSTANTIATE_RESOURCE_HANDLER_SPECIFIC_RESOURCE_SETTINGS = exports.INSTANTIATE_RESOURCE_HANDLER_GENERAL_RESOURCE_SETTINGS = void 0;
+/**
+ * Instantiate Resource Handler General Resource Settings
+ * 实例化资源处理程序普通资源配置
+ */
+exports.INSTANTIATE_RESOURCE_HANDLER_GENERAL_RESOURCE_SETTINGS = {
+    title: 'GraphQL Resolver 资源处理程序',
+    description: ''
+};
+/**
+ * Instantiate Resource Handler Specific Resource Settings
+
+ * 实例化资源处理程序特殊资源配置
+ * 框架通过此实例化此资源
+ */
+exports.INSTANTIATE_RESOURCE_HANDLER_SPECIFIC_RESOURCE_SETTINGS = {
+    code: `export * from "@ldsg/graphql-resolver";`,
+    dependencies: [
+        {
+            name: '@ldsg/graphql-resolver'
+        }
+    ]
+};
+exports.RESOURCE_DEFINITION_GENERAL_RESOURCE_SETTINGS = {
+    title: 'GraphQL Resolver 资源定义',
+    description: ''
+};
+exports.RESOURCE_DEFINITION_SPECIFIC_RESOURCE_SETTINGS = {
+    kind: 'graphql-resolver'
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAIA;;;GAGG;AACU,QAAA,sDAAsD,GAA4B;IAC7F,KAAK,EAAE,yBAAyB;IAChC,WAAW,EAAE,EAAE;CAChB,CAAC;AAEF;;;;;GAKG;AACU,QAAA,uDAAuD,GAAoC;IACtG,IAAI,EAAE,yCAAyC;IAC/C,YAAY,EAAE;QACZ;YACE,IAAI,EAAE,wBAAwB;SAC/B;KACF;CACF,CAAC;AAEW,QAAA,6CAA6C,GAA4B;IACpF,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EAAE,EAAE;CAChB,CAAC;AAEW,QAAA,8CAA8C,GAA+C;IACxG,IAAI,EAAE,kBAAkB;CACzB,CAAC"}

package/dist/handler.d.ts

@@ -0,0 +1,6 @@
+import { Handler, HandlerExtendedResourceSettings } from '@ldsg/handler';
+import { InstantiateResourceParams, InstantiateResourceRes } from '@ldsg/resource';
+import { GraphQLResolverResource } from './resource';
+import { GraphQLResolverSpecificResourceSettings } from './types';
+export declare const handler: Handler<InstantiateResourceParams<HandlerExtendedResourceSettings<GraphQLResolverSpecificResourceSettings>>, InstantiateResourceRes<GraphQLResolverResource>>;
+//# sourceMappingURL=handler.d.ts.map

package/dist/handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../src/handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAEnF,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,uCAAuC,EAAE,MAAM,SAAS,CAAC;AAElE,eAAO,MAAM,OAAO,EAAE,OAAO,CAC3B,yBAAyB,CAAC,+BAA+B,CAAC,uCAAuC,CAAC,CAAC,EACnG,sBAAsB,CAAC,uBAAuB,CAAC,CAC1B,CAAC"}

package/dist/handler.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = void 0;
+const instantiate_resource_1 = require("./instantiate-resource");
+exports.handler = instantiate_resource_1.instantiateResource;
+//# sourceMappingURL=handler.js.map

package/dist/handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.js","sourceRoot":"","sources":["../src/handler.ts"],"names":[],"mappings":";;;AAEA,iEAA6D;AAIhD,QAAA,OAAO,GAGhB,0CAAmB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './constants';
+export * from './handler';
+export * from './instantiate-resource';
+export * from './resource';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./constants"), exports);
+tslib_1.__exportStar(require("./handler"), exports);
+tslib_1.__exportStar(require("./instantiate-resource"), exports);
+tslib_1.__exportStar(require("./resource"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,oDAA0B;AAC1B,iEAAuC;AACvC,qDAA2B;AAC3B,kDAAwB"}

package/dist/instantiate-resource.d.ts

@@ -0,0 +1,6 @@
+import { HandlerExtendedResourceSettings } from '@ldsg/handler';
+import { InstantiateResource } from '@ldsg/resource';
+import { GraphQLResolverResource } from './resource';
+import { GraphQLResolverSpecificResourceSettings } from './types';
+export declare const instantiateResource: InstantiateResource<HandlerExtendedResourceSettings<GraphQLResolverSpecificResourceSettings>, GraphQLResolverResource>;
+//# sourceMappingURL=instantiate-resource.d.ts.map

package/dist/instantiate-resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instantiate-resource.d.ts","sourceRoot":"","sources":["../src/instantiate-resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,uCAAuC,EAAE,MAAM,SAAS,CAAC;AAElE,eAAO,MAAM,mBAAmB,EAAE,mBAAmB,CACnD,+BAA+B,CAAC,uCAAuC,CAAC,EACxE,uBAAuB,CAWxB,CAAC"}

package/dist/instantiate-resource.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instantiateResource = void 0;
+const resource_1 = require("./resource");
+const instantiateResource = (params) => {
+    const { resourceConstructorParams } = params;
+    const resource = new resource_1.GraphQLResolverResource(resourceConstructorParams);
+    const res = {
+        resource
+    };
+    return res;
+};
+exports.instantiateResource = instantiateResource;
+//# sourceMappingURL=instantiate-resource.js.map

package/dist/instantiate-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instantiate-resource.js","sourceRoot":"","sources":["../src/instantiate-resource.ts"],"names":[],"mappings":";;;AAEA,yCAAqD;AAG9C,MAAM,mBAAmB,GAG5B,CAAC,MAAM,EAAE,EAAE;IACb,MAAM,EAAE,yBAAyB,EAAE,GAAG,MAAM,CAAC;IAE7C,MAAM,QAAQ,GAAG,IAAI,kCAAuB,CAAC,yBAAyB,CAAC,CAAC;IAExE,MAAM,GAAG,GAAG;QACV,QAAQ;KACT,CAAC;IAEF,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAbW,QAAA,mBAAmB,uBAa9B"}

package/dist/resource.d.ts

@@ -0,0 +1,6 @@
+import { Resource } from '@ldsg/resource';
+import { GraphQLResolverSpecificResourceSettings } from './types';
+export declare class GraphQLResolverResource extends Resource<GraphQLResolverSpecificResourceSettings> {
+    getResolverConfig: () => GraphQLResolverSpecificResourceSettings;
+}
+//# sourceMappingURL=resource.d.ts.map

package/dist/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,uCAAuC,EAAE,MAAM,SAAS,CAAC;AAElE,qBAAa,uBAAwB,SAAQ,QAAQ,CAAC,uCAAuC,CAAC;IAC5F,iBAAiB,QAAO,uCAAuC,CAE7D;CACH"}

package/dist/resource.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphQLResolverResource = void 0;
+const resource_1 = require("@ldsg/resource");
+class GraphQLResolverResource extends resource_1.Resource {
+    constructor() {
+        super(...arguments);
+        this.getResolverConfig = () => {
+            return this.settings;
+        };
+    }
+}
+exports.GraphQLResolverResource = GraphQLResolverResource;
+//# sourceMappingURL=resource.js.map

package/dist/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAG1C,MAAa,uBAAwB,SAAQ,mBAAiD;IAA9F;;QACE,sBAAiB,GAAG,GAA4C,EAAE;YAChE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC;CAAA;AAJD,0DAIC"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './specific-resource-settings';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./specific-resource-settings"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAAA,uEAA6C"}

package/dist/types/specific-resource-settings.d.ts

@@ -0,0 +1,41 @@
+import { SpecificResourceSettings } from '@ldsg/types';
+export interface GraphQLResolverSpecificResourceSettings extends SpecificResourceSettings {
+    /**
+     * 添加到的类型名称
+     * 'Query' | 'Mutation' | 'User' | 'Post' | ...
+     */
+    typeName: string;
+    /**
+     * 字段名称
+     */
+    fieldName: string;
+    /**
+     * 描述
+     */
+    description?: string;
+    /**
+     * Resolver 所属的对象类型名称
+     * 'User' | 'Post' | 'UserForm' | ...
+     */
+    objectTypeName: string;
+    /**
+     * Resolver 方法名称
+     * 'findById' | 'dataLoaderMany' | 'submit' | ...
+     */
+    resolverName: string;
+    /**
+     * PrepareArgs 配置
+     * 可以是字符串（jsonata 表达式）或对象（直接映射）
+     */
+    prepareArgs?: string | {
+        [key: string]: any;
+    };
+    /**
+     * Projection 配置
+     */
+    projection?: ProjectionConfig;
+}
+export type ProjectionConfig = {
+    [key: string]: 0 | 1 | boolean;
+};
+//# sourceMappingURL=specific-resource-settings.d.ts.map

package/dist/types/specific-resource-settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"specific-resource-settings.d.ts","sourceRoot":"","sources":["../../src/types/specific-resource-settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,MAAM,WAAW,uCAAwC,SAAQ,wBAAwB;IACvF;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;CAChC,CAAC"}

package/dist/types/specific-resource-settings.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=specific-resource-settings.js.map

package/dist/types/specific-resource-settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"specific-resource-settings.js","sourceRoot":"","sources":["../../src/types/specific-resource-settings.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@ldsg/graphql-resolver",
+  "version": "0.1.1",
+  "description": "",
+  "keywords": [],
+  "license": "MIT",
+  "author": "wanxger",
+  "main": "dist/index.js",
+  "types": "dist",
+  "files": [
+    "dist/"
+  ],
+  "dependencies": {
+    "graphql-compose": "^9.1.0",
+    "tslib": "^2.8.1",
+    "@ldsg/handler": "0.3.10",
+    "@ldsg/graphql": "0.3.11",
+    "@ldsg/resource": "0.3.10",
+    "@ldsg/resource-definition": "0.3.10"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.2",
+    "@types/supertest": "^6.0.0",
+    "jest": "^29.5.0",
+    "supertest": "^6.3.4",
+    "ts-jest": "^29.1.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "@ldsg/types": "0.3.10"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "clean": "rm -rf dist",
+    "test": "jest"
+  }
+}