fix: adjustments for pre.34+: use dove generated patchSchema instead of generating one

Author: Mairu

docs/examples/generated_service_v5.md

@@ -2,7 +2,7 @@
 
 1. Go into your `src/services/{$name}` folder, and open the service you want to edit `${name}.[tj]s`
 2. Import the helper function and import the schemas (example for user service):
-```js  {"highlight": "9-11", "lineNumbers": true}
+```js  {"highlight": "9-12", "lineNumbers": true}
   import { createSwaggerServiceOptions } from 'feathers-swagger';
   import {
       userDataValidator,
@@ -14,6 +14,7 @@
       userDataSchema,
       userQuerySchema,
       userSchema,
+      userPatchSchema,
   } from './users.schema';
 ```
 adjust the options when the service is generated
@@ -24,7 +25,7 @@ adjust the options when the service is generated
       // You can add additional custom events to be sent to clients here
       events: [],
       docs: createSwaggerServiceOptions({
-          schemas: { userDataSchema, userQuerySchema, userSchema },
+          schemas: { userDataSchema, userQuerySchema, userSchema, userPatchSchema },
           docs: {
               // any options for service.docs can be added here
               securities: ['find', 'get', 'update', 'patch', 'remove'],

lib/custom-methods.js

@@ -52,7 +52,11 @@ if (checkImport('@feathersjs/express/rest', 'HTTP_METHOD')) {
 
   getCustomMethods = (app, service, defaultMethods, basePath, doc, serviceOptions) => {
     const serviceCustomMethods = [];
-    (serviceOptions || getServiceOptions(service)).methods.forEach((method) => {
+    const localServiceOptions = (serviceOptions || getServiceOptions(service));
+    if (!localServiceOptions || !localServiceOptions.methods) {
+      return serviceCustomMethods;
+    }
+    localServiceOptions.methods.forEach((method) => {
       if (defaultServiceMethods.includes(method)) {
         return;
       }

lib/utils.js

@@ -113,55 +113,83 @@ exports.defaultSanitizeSchema = function defaultSanitizeSchema (schema) {
   ]);
 };
 
+function determineSchemaPrefix (schemas) {
+  const dataSchemaKey = Object.keys(schemas).find(value => value.endsWith('DataSchema'));
+  if (dataSchemaKey) {
+    return dataSchemaKey.replace(/DataSchema$/, '');
+  }
+  const querySchemaKey = Object.keys(schemas).find(value => value.endsWith('QuerySchema'));
+  if (querySchemaKey) {
+    return querySchemaKey.replace(/QuerySchema$/, '');
+  }
+  const patchSchemaKey = Object.keys(schemas).find(value => value.endsWith('PatchSchema'));
+  if (patchSchemaKey) {
+    return patchSchemaKey.replace(/PatchSchema$/, '');
+  }
+  const schemaKey = Object.keys(schemas).find(value => value.endsWith('Schema'));
+  if (schemaKey) {
+    return schemaKey.replace(/Schema$/, '');
+  }
+
+  return undefined;
+}
+
 exports.createSwaggerServiceOptions = function createSwaggerServiceOptions ({ schemas, docs, sanitizeSchema }) {
   const serviceDocs = { schemas: {}, refs: {} };
   const sanitizeSchemaFn = sanitizeSchema || exports.defaultSanitizeSchema;
 
   let unspecificSchemas;
-  const dataSchemaKey = Object.keys(schemas).find(value => value.endsWith('DataSchema'));
-  if (dataSchemaKey) {
-    const prefix = dataSchemaKey.replace(/DataSchema$/, '');
-    const querySchemaKey = `${prefix}QuerySchema`;
+  const prefix = determineSchemaPrefix(schemas);
+  if (prefix) {
     const resultSchemaKey = `${prefix}Schema`;
-    if (schemas[dataSchemaKey] && schemas[querySchemaKey] && schemas[resultSchemaKey]) {
+    const dataSchemaKey = `${prefix}DataSchema`;
+    const querySchemaKey = `${prefix}QuerySchema`;
+    const patchSchemaKey = `${prefix}PatchSchema`;
+    if (schemas[resultSchemaKey]) {
       const {
         [dataSchemaKey]: dataSchema,
         [querySchemaKey]: baseQuerySchema,
         [resultSchemaKey]: resultSchema,
+        [patchSchemaKey]: patchSchema,
         ...otherSchemas
       } = schemas;
       unspecificSchemas = otherSchemas;
 
-      const querySchema = {
-        ...baseQuerySchema,
-        properties: omit(baseQuerySchema.properties, ['$limit', '$skip'])
-      };
-
       const baseSchemeName = resultSchema.$id || prefix;
-      const dataSchemeName = dataSchema.$id || `${baseSchemeName}Data`;
-      const querySchemaName = querySchema.$id || `${baseSchemeName}Query`;
       const listSchemaName = `${baseSchemeName}List`;
 
-      const patchSchemaName = `${baseSchemeName}PatchData`;
-      const patchSchema = omit(dataSchema, ['required', '$id']);
-
       serviceDocs.schemas = {
         [baseSchemeName]: sanitizeSchemaFn(resultSchema),
-        [dataSchemeName]: sanitizeSchemaFn(dataSchema),
-        [querySchemaName]: sanitizeSchemaFn(querySchema),
-        [patchSchemaName]: sanitizeSchemaFn(patchSchema),
         [listSchemaName]: {
           type: 'array',
           items: { $ref: `#/components/schemas/${baseSchemeName}` }
         }
       };
 
-      serviceDocs.refs = {
-        createRequest: dataSchemeName,
-        updateRequest: dataSchemeName,
-        patchRequest: patchSchemaName,
-        queryParameters: querySchemaName
-      };
+      serviceDocs.refs = {};
+
+      if (dataSchema) {
+        const dataSchemeName = dataSchema.$id || `${baseSchemeName}Data`;
+        serviceDocs.schemas[dataSchemeName] = sanitizeSchemaFn(dataSchema);
+        serviceDocs.refs.createRequest = dataSchemeName;
+        serviceDocs.refs.updateRequest = dataSchemeName;
+      }
+
+      if (baseQuerySchema) {
+        const querySchema = {
+          ...baseQuerySchema,
+          properties: omit(baseQuerySchema.properties, ['$limit', '$skip'])
+        };
+        const querySchemaName = querySchema.$id || `${baseSchemeName}Query`;
+        serviceDocs.schemas[querySchemaName] = sanitizeSchemaFn(querySchema);
+        serviceDocs.refs.queryParameters = querySchemaName;
+      }
+
+      if (patchSchema) {
+        const patchSchemaName = patchSchema.$id || `${baseSchemeName}PatchData`;
+        serviceDocs.schemas[patchSchemaName] = sanitizeSchemaFn(patchSchema);
+        serviceDocs.refs.patchRequest = patchSchemaName;
+      }
 
       if (!docs || !docs.model) {
         serviceDocs.model = baseSchemeName;