refactor(api): enable no-unsafe-declaration-merging and fix errors

- Declare all fields in the classes
- Remove redundant interfaces
- Make classes implements their options interface
- Reorder fields as the fields order is not dependent of insertion order anymore
- Reorder fields in test openapi3 test

https://typescript-eslint.io/rules/no-unsafe-declaration-merging/
Signed-off-by: J3m5 <[email protected]>

Author: J3m5

.oxlintrc.json

@@ -30,7 +30,7 @@
       }
     ],
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-unsafe-declaration-merging": "off",
+    "@typescript-eslint/no-unsafe-declaration-merging": "error",
     "eslint/arrow-body-style": ["error", "as-needed"],
     "eslint/curly": "error",
     "eslint/id-length": "off",

src/core/Api.ts

@@ -8,9 +8,12 @@ export interface ApiOptions
     resources?: Resource[];
   }> {}
 
-export interface Api extends ApiOptions {}
-export class Api {
+export class Api implements ApiOptions {
   entrypoint: string;
+
+  title?: string | null;
+  resources?: Resource[] | null;
+
   constructor(entrypoint: string, options: ApiOptions = {}) {
     this.entrypoint = entrypoint;
     assignSealed(this, options);

src/core/Field.ts

@@ -40,16 +40,29 @@ export interface FieldOptions
     enum?: { [key: string | number]: string | number };
     reference?: string | Resource;
     embedded?: Resource;
-    required?: boolean;
     nullable?: boolean;
+    required?: boolean;
     description?: string;
     maxCardinality?: number;
     deprecated?: boolean;
   }> {}
 
-export interface Field extends FieldOptions {}
-export class Field {
+export class Field implements FieldOptions {
   name: string;
+
+  id?: string | null;
+  range?: string | null;
+  type?: FieldType | null;
+  arrayType?: FieldType | null;
+  enum?: { [key: string | number]: string | number } | null;
+  reference?: string | Resource | null;
+  embedded?: Resource | null;
+  nullable?: boolean | null;
+  required?: boolean | null;
+  description?: string | null;
+  maxCardinality?: number | null;
+  deprecated?: boolean | null;
+
   constructor(name: string, options: FieldOptions = {}) {
     this.name = name;
     assignSealed(this, options);

src/core/Operation.ts

@@ -12,10 +12,15 @@ export interface OperationOptions
     deprecated?: boolean;
   }> {}
 
-export interface Operation extends OperationOptions {}
-export class Operation {
+export class Operation implements OperationOptions {
   name: string;
   type: OperationType;
+  method?: string | null;
+  expects?: any | null;
+  returns?: string | null;
+  types?: string[] | null;
+  deprecated?: boolean | null;
+
   constructor(
     name: string,
     type: OperationType,

src/core/Parameter.ts

@@ -1,4 +1,12 @@
-export class Parameter {
+export interface ParameterOptions {
+  variable: string;
+  range: string | null;
+  required: boolean;
+  description: string;
+  deprecated?: boolean | undefined;
+}
+
+export class Parameter implements ParameterOptions {
   variable: string;
   range: string | null;
   required: boolean;

src/core/Resource.ts

@@ -9,19 +9,29 @@ export interface ResourceOptions
     id?: string;
     title?: string;
     description?: string;
-    deprecated?: boolean;
     fields?: Field[];
     readableFields?: Field[];
     writableFields?: Field[];
-    parameters?: Parameter[];
     getParameters?: () => Promise<Parameter[]>;
     operations?: Operation[];
+    deprecated?: boolean;
+    parameters?: Parameter[];
   }> {}
 
-export interface Resource extends ResourceOptions {}
-export class Resource {
+export class Resource implements ResourceOptions {
   name: string;
   url: string;
+  id?: string | null;
+  title?: string | null;
+  description?: string | null;
+  fields?: Field[] | null;
+  readableFields?: Field[] | null;
+  writableFields?: Field[] | null;
+  getParameters?: (() => Promise<Parameter[]>) | null;
+  operations?: Operation[] | null;
+  deprecated?: boolean | null;
+  parameters?: Parameter[] | null;
+
   constructor(name: string, url: string, options: ResourceOptions = {}) {
     this.name = name;
     this.url = url;

src/hydra/types.ts

@@ -23,6 +23,23 @@ interface JsonLdType {
   "@type"?: Iri | Iri[];
 }
 
+/**
+ * A generic expanded JSON‑LD node.
+ *   • Keys are IRIs.
+ *   • Each predicate maps to an *array* of nodes or literal values.
+ *
+ * You can extend this interface with concrete predicates later.
+ */
+export interface JsonLdNode extends JsonLdId, JsonLdType {
+  [predicate: Iri]:
+    | JsonLdNode[] // linked nodes
+    | JsonLdValue[] // literals
+    | JsonLdId[] // references
+    | Iri // e.g. "@id"
+    | Iri[] // e.g. "@type"
+    | undefined; // property may be absent
+}
+
 export interface ExpandedOperation {
   "@type": ["http://www.w3.org/ns/hydra/core#Operation"];
   "http://www.w3.org/2000/01/rdf-schema#label": [JsonLdValue<string>];
@@ -73,7 +90,7 @@ interface ExpandedSupportedProperty {
   "http://www.w3.org/2002/07/owl#deprecated"?: [JsonLdValue<boolean>];
 }
 
-export interface ExpandedClass extends JsonLdNode {
+export interface ExpandedClass {
   "@id": string;
   "@type": ["http://www.w3.org/ns/hydra/core#Class"];
   "http://www.w3.org/2000/01/rdf-schema#label"?: [JsonLdValue<string>];

src/openapi3/handleJson.test.ts

@@ -994,14 +994,7 @@ const parsed = [
         description: "",
       },
     ],
-    parameters: [
-      {
-        variable: "page",
-        range: "integer",
-        required: false,
-        description: "The collection page number",
-      },
-    ],
+
     operations: [
       {
         name: "Retrieves a Book resource.",
@@ -1034,6 +1027,14 @@ const parsed = [
         deprecated: false,
       },
     ],
+    parameters: [
+      {
+        variable: "page",
+        range: "integer",
+        required: false,
+        description: "The collection page number",
+      },
+    ],
   },
   {
     name: "reviews",
@@ -1277,14 +1278,7 @@ const parsed = [
         description: "",
       },
     ],
-    parameters: [
-      {
-        variable: "page",
-        range: "integer",
-        required: false,
-        description: "The collection page number",
-      },
-    ],
+
     operations: [
       {
         name: "Retrieves a Review resource.",
@@ -1317,6 +1311,14 @@ const parsed = [
         deprecated: false,
       },
     ],
+    parameters: [
+      {
+        variable: "page",
+        range: "integer",
+        required: false,
+        description: "The collection page number",
+      },
+    ],
   },
 ];