@skyvexsoftware/stratos-sdk 0.19.0 → 0.19.1

package/dist/helpers/attach-file.d.ts

@@ -2,9 +2,10 @@ import type { PluginFileAttachment } from "../types/context";
 /**
  * Mark a file on disk for attachment to the PIREP.
  *
- * Pure: it touches no filesystem and never throws. Whether the file exists and
- * can be read is resolved when the submission is built, where a failure is
- * already handled without costing the pilot their flight.
+ * This only records the path. It doesn't open or read the file, so it never
+ * throws and never slows the handler. Stratos reads the file later, when the
+ * PIREP is sent, streaming it from disk. A file that can't be read at that
+ * point is skipped with the reason recorded, and the flight still files.
  *
  * @example
  * ```ts

package/dist/helpers/attach-file.js

@@ -1,9 +1,10 @@
 /**
  * Mark a file on disk for attachment to the PIREP.
  *
- * Pure: it touches no filesystem and never throws. Whether the file exists and
- * can be read is resolved when the submission is built, where a failure is
- * already handled without costing the pilot their flight.
+ * This only records the path. It doesn't open or read the file, so it never
+ * throws and never slows the handler. Stratos reads the file later, when the
+ * PIREP is sent, streaming it from disk. A file that can't be read at that
+ * point is skipped with the reason recorded, and the flight still files.
  *
  * @example
  * ```ts

package/dist/types/context.d.ts

@@ -170,8 +170,12 @@ export type PluginFlightAccessor = {
      * nothing.
      *
      * Handlers are fail-open: a throw, a rejection, a timeout (3s), a
-     * non-object return, or a payload over 256 KB omits this plugin's key and
-     * the PIREP is submitted regardless.
+     * non-object return, or returned data over the size cap omits this plugin's
+     * key and the PIREP is submitted regardless. The cap is 256 KB per plugin
+     * and 512 KB across all plugins, measured on the returned JSON. Files
+     * attached with `attachFile()` do not count towards it; each is only a
+     * short reference in the JSON and is sent as its own part, with no size
+     * limit.
      *
      * Handlers run only for `completed`, `diverted` and `crashed` flights, never
      * for cancelled ones, and only when an airline is bound. If the airline

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyvexsoftware/stratos-sdk",
-  "version": "0.19.0",
+  "version": "0.19.1",
   "description": "Plugin SDK for Stratos — types, hooks, and UI components",
   "author": {
     "name": "Skyvex Software Pty Ltd",