@platformatic/globals 3.57.0 → 3.58.0

package/README.md

@@ -1,6 +1,8 @@
 # @platformatic/globals
 
-Platformatic Globals exports access to Platformatic runtime APIs.
+Typed accessors for Platformatic runtime APIs.
+
+Applications use `@platformatic/globals` to read runtime context, use the shared logger, exchange messages, register metrics, customize health checks, and publish metadata while running inside Watt or Platformatic Runtime.
 
 ## Install
 
@@ -10,16 +12,31 @@ npm install @platformatic/globals
 
 ## Usage
 
-```ts
-import { getApplicationId, getCapability, getClosing, getMessaging } from '@platformatic/globals'
+```js
+import { getApplicationId, getLogger, getMessaging } from '@platformatic/globals'
 
 const applicationId = getApplicationId()
-const capability = getCapability()
-const closing = getClosing()
+const logger = getLogger()
 const messaging = getMessaging()
+
+logger.info({ applicationId }, 'Application started')
+
+messaging.handle('ping', () => 'pong')
 ```
 
-Direct access through the legacy global object is still supported for compatibility, but deprecated. Use the typed getters instead.
+Runtime APIs are injected when the application runs inside Watt or Platformatic Runtime. Most getters throw when the requested API is not available. Pass `{ throwOnMissing: false }` to return `undefined` instead:
+
+```js
+import { getBasePath } from '@platformatic/globals'
+
+const basePath = getBasePath({ throwOnMissing: false }) ?? ''
+```
+
+Direct access through the legacy `globalThis.platformatic` object is still supported for compatibility, but deprecated. Use the typed getters and setters instead.
+
+## Documentation
+
+See the [Runtime APIs reference](https://docs.platformatic.dev/docs/reference/runtime/globals) for the complete API list and examples.
 
 ## License
 

package/lib/index.d.ts

@@ -65,7 +65,7 @@ export interface PlatformaticGlobal {
   executable: string
   runtimeId: number
   nextVersion: { major: number, minor?: number }
-  exitOnUnhandledErrors: boolean
+  exitOnUnhandledErrors: boolean | number
   reuseTcpPorts: boolean
 
   // Service configuration
@@ -74,6 +74,8 @@ export interface PlatformaticGlobal {
   additionalServerOptions: object
   telemetryConfig: object
   config: object
+  runtimeConfig: object
+  applicationConfig: object | null
   applicationId: string
   workerId: number | string
   root: string
@@ -182,6 +184,12 @@ export declare function getTelemetryConfig (options: GlobalGetterOptions): Platf
 export declare function getConfig (options?: RequiredGlobalGetterOptions): PlatformaticGlobal['config']
 export declare function getConfig (options: OptionalGlobalGetterOptions): PlatformaticGlobal['config'] | undefined
 export declare function getConfig (options: GlobalGetterOptions): PlatformaticGlobal['config'] | undefined
+export declare function getRuntimeConfig (options?: RequiredGlobalGetterOptions): PlatformaticGlobal['runtimeConfig']
+export declare function getRuntimeConfig (options: OptionalGlobalGetterOptions): PlatformaticGlobal['runtimeConfig'] | undefined
+export declare function getRuntimeConfig (options: GlobalGetterOptions): PlatformaticGlobal['runtimeConfig'] | undefined
+export declare function getApplicationConfig (options?: RequiredGlobalGetterOptions): PlatformaticGlobal['applicationConfig']
+export declare function getApplicationConfig (options: OptionalGlobalGetterOptions): PlatformaticGlobal['applicationConfig'] | undefined
+export declare function getApplicationConfig (options: GlobalGetterOptions): PlatformaticGlobal['applicationConfig'] | undefined
 export declare function getApplicationId (options?: RequiredGlobalGetterOptions): PlatformaticGlobal['applicationId']
 export declare function getApplicationId (options: OptionalGlobalGetterOptions): PlatformaticGlobal['applicationId'] | undefined
 export declare function getApplicationId (options: GlobalGetterOptions): PlatformaticGlobal['applicationId'] | undefined

package/lib/index.js

@@ -87,6 +87,14 @@ export function getConfig (options) {
   return getField('config', options)
 }
 
+export function getRuntimeConfig (options) {
+  return getField('runtimeConfig', options)
+}
+
+export function getApplicationConfig (options) {
+  return getField('applicationConfig', options)
+}
+
 export function getApplicationId (options) {
   return getField('applicationId', options)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/globals",
-  "version": "3.57.0",
+  "version": "3.58.0",
   "description": "Platformatic Global Object Getter",
   "type": "module",
   "main": "./lib/index.js",
@@ -21,7 +21,16 @@
   "bugs": {
     "url": "https://github.com/platformatic/platformatic/issues"
   },
-  "homepage": "https://github.com/platformatic/platformatic#readme",
+  "homepage": "https://docs.platformatic.dev/docs/reference/runtime/globals",
+  "keywords": [
+    "platformatic",
+    "watt",
+    "runtime",
+    "globals",
+    "logger",
+    "metrics",
+    "messaging"
+  ],
   "devDependencies": {
     "@types/node": "^22.10.6",
     "cleaner-spec-reporter": "^0.5.0",