Tweak exports and formats

Author: jdalton

eslint.config.js renamed to eslint.config.mjs

@@ -1,23 +1,28 @@
-'use strict'
+import { createRequire } from 'node:module'
+import path from 'node:path'
+import url from 'node:url'
 
-const path = require('node:path')
-
-const {
+import {
   convertIgnorePatternToMinimatch,
   includeIgnoreFile
-} = require('@eslint/compat')
-const jsPlugin = require('@eslint/js')
-const tsParser = require('@typescript-eslint/parser')
-const { createOxcImportResolver } = require('eslint-import-resolver-oxc')
-const importXPlugin = require('eslint-plugin-import-x')
-const jsdocPlugin = require('eslint-plugin-jsdoc')
-const nodePlugin = require('eslint-plugin-n')
-const sortDestructureKeysPlugin = require('eslint-plugin-sort-destructure-keys')
-const unicornPlugin = require('eslint-plugin-unicorn')
-const globals = require('globals')
-const tsEslint = require('typescript-eslint')
+} from '@eslint/compat'
+import jsPlugin from '@eslint/js'
+import tsParser from '@typescript-eslint/parser'
+import { createOxcImportResolver } from 'eslint-import-resolver-oxc'
+import importXPlugin from 'eslint-plugin-import-x'
+import jsdocPlugin from 'eslint-plugin-jsdoc'
+import nodePlugin from 'eslint-plugin-n'
+import sortDestructureKeysPlugin from 'eslint-plugin-sort-destructure-keys'
+import unicornPlugin from 'eslint-plugin-unicorn'
+import globals from 'globals'
+import tsEslint from 'typescript-eslint'
+
+import constants from '@socketsecurity/registry/lib/constants'
+
+const __filename = url.fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const require = createRequire(import.meta.url)
 
-const constants = require('@socketsecurity/registry/lib/constants')
 const { BIOME_JSON, GITIGNORE, LATEST, TSCONFIG_JSON } = constants
 
 const { flatConfigs: origImportXFlatConfigs } = importXPlugin
@@ -141,7 +146,7 @@ function getImportXFlatConfigs(isEsm) {
 const importFlatConfigsForScript = getImportXFlatConfigs(false)
 const importFlatConfigsForModule = getImportXFlatConfigs(true)
 
-module.exports = [
+export default [
   includeIgnoreFile(gitignorePath),
   {
     name: 'Imported biome.json ignore patterns',

package.json

@@ -13,13 +13,38 @@
     "type": "git",
     "url": "git://github.com/SocketDev/socket-sdk-js.git"
   },
-  "main": "./dist/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "node": {
+        "module-sync": {
+          "types": "./dist/index.d.mts",
+          "default": "./dist/index.js"
+        },
+        "default": {
+          "types": "./dist/index.d.cts",
+          "default": "./dist/index.cjs"
+        }
+      },
+      "default": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./dist/index.cjs": {
+      "types": "./dist/index.d.cts",
+      "default": "./dist/index.cjs"
+    },
+    "./dist/index.d.cts": "./dist/index.d.cts",
+    "./dist/index.d.mts": "./dist/index.d.mts",
+    "./package.json": "./package.json"
+  },
   "scripts": {
-    "build": "npm run clean && run-p -c --aggregate-output build:*",
+    "build": "npm run clean && run-p -c --aggregate-output build:* && run-p -c --aggregate-output build:clean:*",
     "build:cjs": "tsc",
     "build:esm": "tsc -p tsconfig.esm.json",
+    "build:clean:cjs": "node scripts/rename-dist-cjs-files.mjs",
+    "build:clean:esm": "node scripts/rename-dist-esm-files.mjs",
     "check": "run-p -c --aggregate-output check:*",
     "check:lint": "eslint --report-unused-disable-directives .",
     "check:lint:fix": "npm run check:lint -- --fix",
@@ -29,10 +54,11 @@
     "coverage:type": "type-coverage --detail",
     "ci-test": "run-s build test:*",
     "clean": "run-p clean:*",
+    "clean:dist": "del-cli 'dist'",
     "clean:declarations": "del-cli '*.d.ts' '!api*.d.ts'",
     "fix": "run-s lint:fix check:lint:fix",
-    "generate-sdk:0-prettify": "node scripts/prettify-base-json.js",
-    "generate-sdk:1-generate": "node scripts/generate-types.js > types/api.d.ts",
+    "generate-sdk:0-prettify": "node scripts/prettify-base-json.mjs",
+    "generate-sdk:1-generate": "node scripts/generate-types.mjs > types/api.d.ts",
     "generate-sdk": "run-s generate-sdk:*",
     "knip:dependencies": "knip --dependencies",
     "knip:exports": "knip --include exports,duplicates",

scripts/generate-types.js

@@ -0,0 +1,26 @@
+import path from 'node:path'
+import url from 'node:url'
+
+import openapiTS from 'openapi-typescript'
+
+const __filename = url.fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+const rootPath = path.join(__dirname, '..')
+const openApiJsonPath = path.join(rootPath, 'openapi.json')
+
+void (async () => {
+  try {
+    const output = await openapiTS(openApiJsonPath, {
+      transform(schemaObject) {
+        if ('format' in schemaObject && schemaObject.format === 'binary') {
+          return 'never'
+        }
+      }
+    })
+    console.log(output)
+  } catch (e) {
+    process.exitCode = 1
+    console.error('Failed with error:', e)
+  }
+})()

scripts/generate-types.mjs

@@ -0,0 +1,22 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import url from 'node:url'
+
+const __filename = url.fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+const rootPath = path.join(__dirname, '..')
+const openApiJsonPath = path.join(rootPath, 'openapi.json')
+
+void (async () => {
+  try {
+    const openApiData = await fs.readFile(openApiJsonPath, 'utf8')
+    await fs.writeFile(
+      openApiJsonPath,
+      JSON.stringify(JSON.parse(openApiData), null, 2)
+    )
+  } catch (e) {
+    process.exitCode = 1
+    console.error('Failed with error:', e.stack)
+  }
+})()

scripts/prettify-base-json.js

@@ -0,0 +1,35 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import url from 'node:url'
+
+const __filename = url.fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+const rootPath = path.join(__dirname, '..')
+const distPath = path.join(rootPath, 'dist')
+const distCjsPath = path.join(distPath, 'cjs')
+
+void (async () => {
+  await Promise.all([
+    fs.rename(
+      path.join(distCjsPath, 'index.d.ts'),
+      path.join(distPath, 'index.d.cts')
+    ),
+    fs.rename(
+      path.join(distCjsPath, 'index.d.ts.map'),
+      path.join(distPath, 'index.d.cts.map')
+    ),
+    fs.rename(
+      path.join(distCjsPath, 'index.js'),
+      path.join(distPath, 'index.cjs')
+    ),
+    fs.rename(
+      path.join(distCjsPath, 'index.js.map'),
+      path.join(distPath, 'index.cjs.map')
+    )
+  ])
+  await Promise.all([
+    fs.rm(distCjsPath, { recursive: true }),
+    fs.rm(path.join(distPath, 'tsconfig.tsbuildinfo'))
+  ])
+})()

scripts/prettify-base-json.mjs

@@ -0,0 +1,35 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import url from 'node:url'
+
+const __filename = url.fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+const rootPath = path.join(__dirname, '..')
+const distPath = path.join(rootPath, 'dist')
+const distEsmPath = path.join(distPath, 'esm')
+
+void (async () => {
+  await Promise.all([
+    fs.rename(
+      path.join(distEsmPath, 'index.d.ts'),
+      path.join(distPath, 'index.d.mts')
+    ),
+    fs.rename(
+      path.join(distEsmPath, 'index.d.ts.map'),
+      path.join(distPath, 'index.d.mts.map')
+    ),
+    fs.rename(
+      path.join(distEsmPath, 'index.js'),
+      path.join(distPath, 'index.js')
+    ),
+    fs.rename(
+      path.join(distEsmPath, 'index.js.map'),
+      path.join(distPath, 'index.js.map')
+    )
+  ])
+  await Promise.all([
+    fs.rm(distEsmPath, { recursive: true }),
+    fs.rm(path.join(distPath, 'tsconfig.esm.tsbuildinfo'))
+  ])
+})()

scripts/rename-dist-cjs-files.mjs

@@ -34,7 +34,7 @@ export interface SocketSdkOptions {
   userAgent?: string | undefined
 }
 
-const rootPath = path.join(__dirname, '../..')
+const rootPath = path.join(__dirname, '..')
 const rootPkgJsonPath = path.join(rootPath, 'package.json')
 
 const defaultUserAgent = createUserAgentFromPkgJson(require(rootPkgJsonPath))

scripts/rename-dist-esm-files.mjs

@@ -1,7 +1,7 @@
 import nock from 'nock'
 import { afterEach, beforeEach, describe, expect, it } from 'vitest'
 
-import { SocketSdk } from '../dist/esm/index.js'
+import { SocketSdk } from '../dist/index.js'
 
 process.on('unhandledRejection', cause => {
   throw new Error('Unhandled rejection', { cause })