@platformatic/tanstack 0.0.1 → 3.27.0

package/lib/capability.js

@@ -0,0 +1,159 @@
+import { cleanBasePath, createServerListener, ensureTrailingSlash, errors, getServerUrl } from '@platformatic/basic'
+import { importFile, resolvePackageViaESM } from '@platformatic/basic/lib/utils.js'
+import { ensureLoggableError } from '@platformatic/foundation'
+import { ViteCapability } from '@platformatic/vite'
+import inject from 'light-my-request'
+import { existsSync } from 'node:fs'
+import { readFile } from 'node:fs/promises'
+import { dirname, resolve } from 'node:path'
+import { satisfies } from 'semver'
+import { packageJson } from './schema.js'
+
+const supportedVersions = '^1.0.0'
+
+export class TanstackCapability extends ViteCapability {
+  #tanstack
+  #basePath
+  #server
+  #dispatcher
+
+  constructor (root, config, context) {
+    super(root, config, context)
+    this.type = 'tanstack'
+    this.version = packageJson.version
+  }
+
+  async init () {
+    await super.init()
+
+    if (!this.isProduction) {
+      this.#tanstack = resolve(dirname(await resolvePackageViaESM(this.root, '@tanstack/react-start')), '../..')
+      const tanstackPackage = JSON.parse(await readFile(resolve(this.#tanstack, 'package.json'), 'utf-8'))
+
+      if (!satisfies(tanstackPackage.version, supportedVersions)) {
+        throw new errors.UnsupportedVersion('@tanstack/react-start', tanstackPackage.version, supportedVersions)
+      }
+    }
+
+    const config = this.config
+    this.#basePath = config.application?.basePath
+      ? ensureTrailingSlash(cleanBasePath(config.application?.basePath))
+      : undefined
+
+    this.registerGlobals({ basePath: this.#basePath })
+
+    this.subprocessTerminationSignal = 'SIGKILL'
+  }
+
+  async start ({ listen }) {
+    // Make this idempotent
+    /* c8 ignore next 3 */
+    if (this.url) {
+      return this.url
+    }
+
+    await super._start({ listen })
+
+    const config = this.config
+    const command = config.application.commands[this.isProduction ? 'production' : 'development']
+
+    if (command) {
+      return this.startWithCommand(command)
+    } else if (!this.isProduction) {
+      return super.start({ listen })
+    }
+
+    await this.#startProduction({ listen })
+  }
+
+  async #startProduction () {
+    const config = this.config
+    const outputDirectory = resolve(this.root, config.application.outputDirectory)
+    this.verifyOutputDirectory(outputDirectory)
+
+    const buildInfoPath = resolve(outputDirectory, '.platformatic-build.json')
+
+    if (!this.#basePath && existsSync(buildInfoPath)) {
+      try {
+        const buildInfo = JSON.parse(await readFile(buildInfoPath, 'utf-8'))
+        this.#basePath = buildInfo.basePath
+      } catch (e) {
+        globalThis.platformatic.logger.error({ err: ensureLoggableError(e) }, 'Reading build info failed.')
+      }
+    }
+
+    const serverOptions = this.serverConfig
+    const serverPromise = createServerListener(
+      serverOptions?.port ?? true,
+      serverOptions?.hostname ?? true,
+      typeof serverOptions?.backlog === 'number' ? { backlog: serverOptions.backlog } : {}
+    )
+
+    await importFile(resolve(outputDirectory, 'server/index.mjs'))
+
+    this.#server = await serverPromise
+    this.#dispatcher = this.#server.listeners('request')[0]
+    this.url = getServerUrl(this.#server)
+    await this._collectMetrics()
+
+    return this.url
+  }
+
+  async stop () {
+    const hasChildrenManager = !!this.childManager
+    await super.stop()
+
+    // ViteCapability.stop already stops child processs
+    if (hasChildrenManager || !this.isProduction) {
+      return
+    }
+
+    /* c8 ignore next 3 */
+    if (!this.#server?.listening) {
+      return
+    }
+
+    return new Promise((resolve, reject) => {
+      this.#server.close(error => {
+        /* c8 ignore next 3 */
+        if (error) {
+          return reject(error)
+        }
+
+        resolve()
+      })
+    })
+  }
+
+  getMeta () {
+    if (!this.isProduction) {
+      return super.getMeta()
+    }
+
+    return {
+      gateway: {
+        tcp: typeof this.url !== 'undefined',
+        url: this.url,
+        prefix: this.basePath ?? this.#basePath,
+        wantsAbsoluteUrls: true,
+        needsRootTrailingSlash: true
+      }
+    }
+  }
+
+  async inject (injectParams, onInject) {
+    if (!this.isProduction) {
+      return super.inject(injectParams, onInject)
+    }
+
+    const res = await inject(this.#dispatcher, injectParams, onInject)
+
+    /* c8 ignore next 3 */
+    if (onInject) {
+      return
+    } // Since inject might be called from the main thread directly via ITC, let's clean it up
+
+    const { statusCode, headers, body, payload, rawPayload } = res
+    return { statusCode, headers, body, payload, rawPayload }
+  }
+}

package/lib/schema.js

@@ -0,0 +1,34 @@
+import { schemaComponents as basicSchemaComponents } from '@platformatic/basic'
+import { schemaComponents as utilsSchemaComponents } from '@platformatic/foundation'
+import { schemaComponents as viteSchemaComponents } from '@platformatic/vite'
+import { readFileSync } from 'node:fs'
+import { resolve } from 'node:path'
+
+export const packageJson = JSON.parse(readFileSync(resolve(import.meta.dirname, '../package.json'), 'utf8'))
+export const version = packageJson.version
+
+export const schemaComponents = {}
+
+export const schema = {
+  $id: `https://schemas.platformatic.dev/@platformatic/tanstack/${packageJson.version}.json`,
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Platformatic TanStack Config',
+  type: 'object',
+  properties: {
+    $schema: {
+      type: 'string'
+    },
+    logger: utilsSchemaComponents.logger,
+    server: utilsSchemaComponents.server,
+    watch: basicSchemaComponents.watch,
+    application: basicSchemaComponents.buildableApplication,
+    runtime: utilsSchemaComponents.wrappedRuntime,
+    vite: viteSchemaComponents.vite
+  },
+  additionalProperties: false
+}
+
+/* c8 ignore next 3 */
+if (process.argv[1] === import.meta.filename) {
+  console.log(JSON.stringify(schema, null, 2))
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/tanstack",
-  "version": "0.0.1",
+  "version": "3.27.0",
   "description": "Platformatic TanStack Capability",
   "main": "index.js",
   "type": "module",
@@ -14,7 +14,43 @@
     "url": "https://github.com/platformatic/platformatic/issues"
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
+  "dependencies": {
+    "semver": "^7.6.3",
+    "@platformatic/basic": "3.27.0",
+    "@platformatic/foundation": "3.27.0",
+    "@platformatic/vite": "3.27.0"
+  },
+  "devDependencies": {
+    "@tanstack/react-router": "^1.139.7",
+    "@tanstack/react-start": "^1.139.8",
+    "@tanstack/solid-router": "^1.139.12",
+    "@tanstack/solid-start": "^1.139.12",
+    "@vitejs/plugin-react": "^5.1.1",
+    "cleaner-spec-reporter": "^0.5.0",
+    "eslint": "9",
+    "fastify": "^5.0.0",
+    "json-schema-to-typescript": "^15.0.1",
+    "neostandard": "^0.12.0",
+    "nitro": "3.0.1-alpha.1",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "solid-js": "^1.9.10",
+    "typescript": "^5.5.4",
+    "vite": "^7.2.4",
+    "vite-plugin-solid": "^2.11.10",
+    "vite-tsconfig-paths": "^5.1.4",
+    "ws": "^8.18.0",
+    "@platformatic/gateway": "3.27.0",
+    "@platformatic/service": "3.27.0"
+  },
   "engines": {
     "node": ">=22.19.0"
+  },
+  "scripts": {
+    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
+    "gen-schema": "node lib/schema.js > schema.json",
+    "gen-types": "json2ts > config.d.ts < schema.json",
+    "build": "npm run gen-schema && npm run gen-types",
+    "lint": "eslint"
   }
 }