Typescript

.github/workflows/lint.yml

@@ -43,3 +43,25 @@ jobs:
         run: pnpm install
       - name: Lint JS files
         run: pnpm run lint
+  Typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+      - name: Restore node_modules cache
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-modules
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+      - name: Install dependencies
+        run: pnpm install
+      - name: Typecheck files
+        run: pnpm run typecheck

package.json

@@ -23,17 +23,15 @@
   "files": [
     "dist"
   ],
-  "dependencies": {
-    "@ungap/structured-clone": "^1.0.1"
-  },
   "devDependencies": {
     "prettier": "^3.3.3",
     "vite": "^6.3.5",
     "vitest": "^3.2.4"
   },
   "scripts": {
-    "build": "vite build",
-    "lint": "prettier --check 'src/**/*.js'",
+    "typecheck": "tsc --noEmit",
+    "build": "vite build && tsc",
+    "lint": "prettier --check 'src/**/*'",
     "test": "vitest"
   },
   "packageManager": "[email protected]"

src/__tests__/alchemyApiDeserializer.spec.js → 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 → 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 → 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 → src/deserialize.ts

@@ -1,6 +1,4 @@
-import structuredClone from "@ungap/structured-clone"
-
-export function deserialize(originalResponse, options = {}) {
+export function deserialize(originalResponse: any, options = {}) {
   const response = structuredClone(originalResponse)
   if (!options) {
     options = {}
@@ -9,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 {
@@ -22,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 = {}
   }
@@ -47,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,
@@ -77,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.ts

@@ -0,0 +1,2 @@
+export * from "./alchemyApiDeserializer"
+export * from "./deserialize"

tsconfig.json

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

vite.config.ts

@@ -1,8 +1,6 @@
 import { defineConfig } from "vite"
 import { resolve } from "path"
 
-const external = ["@ungap/structured-clone"]
-
 export default defineConfig({
   build: {
     lib: {
@@ -12,9 +10,6 @@ export default defineConfig({
       },
       formats: ["es"],
       fileName: (_format, entryName) => `${entryName}.js`
-    },
-    rollupOptions: {
-      external
     }
   }
 })

vitest.config.mjs

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