Hydra: Skip resource property without GET collection operation instead of throwing (#134)

* refactor(parseHydraDocumentation): skip ressource property without GET collection operation

* chore(config): add yarn.lock, adjust .gitignore, fix tsconfig.eslint.json, formatting

---------

Co-authored-by: JH <je.hu@pm.me>

Author: J3m5

.eslintrc.cjs

@@ -6,13 +6,13 @@ module.exports = {
     commonjs: true,
     es6: true,
     jest: true,
-    node: true
+    node: true,
   },
   parser: "@typescript-eslint/parser",
   parserOptions: {
     ecmaVersion: 7,
     sourceType: "module",
-    project: ["./tsconfig.eslint.json"]
+    project: ["./tsconfig.eslint.json"],
   },
   plugins: ["@typescript-eslint"],
 
@@ -23,15 +23,15 @@ module.exports = {
     "plugin:import/recommended",
     "plugin:import/typescript",
     "prettier",
-    "plugin:prettier/recommended"
+    "plugin:prettier/recommended",
   ],
 
   rules: {
     "prettier/prettier": "error",
     "@typescript-eslint/consistent-type-imports": "error",
     "@typescript-eslint/no-empty-interface": [
       "error",
-      { allowSingleExtends: true }
+      { allowSingleExtends: true },
     ],
     "@typescript-eslint/no-use-before-define": ["error", { functions: false }],
     "@typescript-eslint/no-explicit-any": [0],
@@ -43,7 +43,7 @@ module.exports = {
   settings: {
     "import/resolver": {
       typescript: true,
-      node: true
-    }
-  }
+      node: true,
+    },
+  },
 };

.gitignore

@@ -1,4 +1,3 @@
 /lib/
 /node_modules/
-/yarn.lock
 /yarn-error.log

jest.config.ts

@@ -1,16 +1,16 @@
-import type { Config } from '@jest/types';
+import type { Config } from "@jest/types";
 
 const config: Config.InitialOptions = {
-  extensionsToTreatAsEsm: ['.ts'],
-  setupFilesAfterEnv: ['./jest.setup.ts'],
+  extensionsToTreatAsEsm: [".ts"],
+  setupFilesAfterEnv: ["./jest.setup.ts"],
   moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
+    "^(\\.{1,2}/.*)\\.js$": "$1",
   },
   transform: {
-    '^.+\\.ts$': [
-      'ts-jest',
+    "^.+\\.ts$": [
+      "ts-jest",
       {
-        useESM: true
+        useESM: true,
       },
     ],
   },

src/hydra/parseHydraDocumentation.ts

@@ -244,10 +244,24 @@ export default function parseHydraDocumentation(
           properties,
           '["http://www.w3.org/ns/hydra/core#property"][0]'
         ) as ExpandedRdfProperty | undefined;
+
         if (!property) {
           continue;
         }
 
+        const url = get(entrypoint, `[0]["${property["@id"]}"][0]["@id"]`) as
+          | string
+          | undefined;
+
+        if (!url) {
+          console.error(
+            new Error(
+              `Unable to find the URL for "${property["@id"]}" in the entrypoint, make sure your API resource has at least one GET collection operation declared.`
+            )
+          );
+          continue;
+        }
+
         // Add fields
         const relatedClass = findRelatedClass(docs, property);
         for (const supportedProperties of relatedClass[
@@ -435,15 +449,6 @@ export default function parseHydraDocumentation(
           operations.push(operation);
         }
 
-        const url = get(entrypoint, `[0]["${property["@id"]}"][0]["@id"]`) as
-          | string
-          | undefined;
-        if (!url) {
-          throw new Error(
-            `Unable to find the URL for "${property["@id"]}" in the entrypoint, make sure your API resource has at least one GET collection operation declared.`
-          );
-        }
-
         const resource = new Resource(
           guessNameFromUrl(url, entrypointUrl),
           url,

tsconfig.eslint.json

@@ -1,4 +1,5 @@
 {
   "extends": "./tsconfig.json",
+  "include": ["jest.config.ts", ".eslintrc.cjs", "./src"],
   "exclude": []
 }