refactor: to typescript

We change the source files to .ts files and type everything with any to initially satisfy the typescript compiler.

Author: lassediercks

package.json

@@ -29,7 +29,7 @@
     "vitest": "^3.2.4"
   },
   "scripts": {
-    "build": "vite build",
+    "build": "vite build && tsc",
     "lint": "prettier --check 'src/**/*.js'",
     "test": "vitest"
   },

src/__tests__/alchemyApiDeserializer.spec.js renamed to src/__tests__/alchemyApiDeserializer.spec.ts

@@ -1,4 +1,5 @@
 import { deserializePage, deserializePages } from "../alchemyApiDeserializer"
+import { describe, expect, it } from "vitest"
 
 describe("deserializePage", () => {
   it("does not return any deprecated elements for single page", () => {

src/__tests__/deserialize.spec.js renamed to src/__tests__/deserialize.spec.ts

@@ -1,4 +1,5 @@
 import { deserialize } from "../deserialize"
+import { describe, expect, it } from "vitest"
 
 describe("deserialize", () => {
   it("Complex serialize", () => {

src/alchemyApiDeserializer.js renamed to src/alchemyApiDeserializer.ts

@@ -1,10 +1,10 @@
 import { deserialize } from "./deserialize"
 
 // Recursively filters all deprecated elements and essences from collection
-function filterDeprecatedElements(elements) {
-  const els = []
+function filterDeprecatedElements(elements: any) {
+  const els: any = []
 
-  elements.forEach((element) => {
+  elements.forEach((element: any) => {
     if (element.nested_elements?.length > 0) {
       element.nested_elements = filterDeprecatedElements(
         element.nested_elements
@@ -14,7 +14,7 @@ function filterDeprecatedElements(elements) {
       element.nestedElements = filterDeprecatedElements(element.nestedElements)
     }
     if (element.essences?.length > 0) {
-      element.essences = element.essences.filter((essence) => {
+      element.essences = element.essences.filter((essence: any) => {
         return !essence.deprecated
       })
     }
@@ -27,16 +27,16 @@ function filterDeprecatedElements(elements) {
 }
 
 // Returns deserialized page without deprecated content
-export function deserializePage(pageData) {
+export function deserializePage(pageData: any) {
   const page = deserialize(pageData)
   page.elements = filterDeprecatedElements(page.elements)
   return page
 }
 
 // Returns deserialized pages without deprecated content
-export function deserializePages(pagesData) {
+export function deserializePages(pagesData: any) {
   const pages = deserialize(pagesData)
-  pages.forEach((page) => {
+  pages.forEach((page: any) => {
     page.elements = filterDeprecatedElements(page.elements)
   })
   return pages

src/deserialize.js renamed to src/deserialize.ts

@@ -1,4 +1,4 @@
-export function deserialize(originalResponse, options = {}) {
+export function deserialize(originalResponse: any, options = {}) {
   const response = structuredClone(originalResponse)
   if (!options) {
     options = {}
@@ -7,7 +7,7 @@ export function deserialize(originalResponse, options = {}) {
   const included = response.included || []
 
   if (Array.isArray(response.data)) {
-    return response.data.map((data) => {
+    return response.data.map((data: any) => {
       return parseJsonApiSimpleResourceData(data, included, false, options)
     })
   } else {
@@ -20,7 +20,12 @@ export function deserialize(originalResponse, options = {}) {
   }
 }
 
-function parseJsonApiSimpleResourceData(data, included, useCache, options) {
+function parseJsonApiSimpleResourceData(
+  data: any,
+  included: any,
+  useCache: any,
+  options: any
+) {
   if (!included.cached) {
     included.cached = {}
   }
@@ -45,9 +50,9 @@ function parseJsonApiSimpleResourceData(data, included, useCache, options) {
       const relationRef = data.relationships[relationName]
 
       if (Array.isArray(relationRef.data)) {
-        const items = []
+        const items: any = []
 
-        relationRef.data.forEach((relationData) => {
+        relationRef.data.forEach((relationData: any) => {
           const item = findJsonApiIncluded(
             included,
             relationData.type,
@@ -75,10 +80,10 @@ function parseJsonApiSimpleResourceData(data, included, useCache, options) {
   return resource
 }
 
-function findJsonApiIncluded(included, type, id, options) {
+function findJsonApiIncluded(included: any, type: any, id: any, options: any) {
   let found = null
 
-  included.forEach((item) => {
+  included.forEach((item: any) => {
     if (item.type === type && item.id === id) {
       found = parseJsonApiSimpleResourceData(item, included, true, options)
     }

src/main.js renamed to src/main.ts

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "outDir": "dist",
+    "removeComments": true,
+    "noImplicitAny": true,
+    "declaration": true,
+    "emitDeclarationOnly": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["src/__tests__"]
+}

tsconfig.json

@@ -2,6 +2,6 @@ import { defineConfig } from "vitest/config"
 
 export default defineConfig({
   test: {
-    globals: true
+    globals: false
   }
 })