@immediately-run/sdk 0.64.1 → 0.65.0

package/dist/useEntryState.d.cts

@@ -0,0 +1,28 @@
+import { NavigationDirection } from './entryState.cjs';
+
+/**
+ * Read the value this app left on the current history entry, and queue the value to
+ * leave on the entry the next navigation departs from.
+ *
+ * `value` is `undefined` on an ordinary forward navigation — there is no bookmark for
+ * a page being visited for the first time — and on a traversal to an entry that was
+ * stamped by nothing (a navigation the app did not initiate).
+ *
+ * `save` queues; it does not send. The queued value travels with the next
+ * `navigate()`, which is the only moment the app knows an entry is being left.
+ */
+declare const useEntryState: <T>(key: string) => {
+    value: T | undefined;
+    save: (value: T) => void;
+};
+/**
+ * How the browser reached the page being rendered: `push` for an ordinary
+ * navigation, `back`/`forward` for a history traversal.
+ *
+ * An app that resets its own view on arrival — scrolling a container to the top is
+ * the usual one — should stand down on a traversal, so a restored position is not
+ * immediately thrown away.
+ */
+declare const useNavigationDirection: () => NavigationDirection;
+
+export { useEntryState, useNavigationDirection };

package/dist/useEntryState.d.ts

@@ -0,0 +1,28 @@
+import { NavigationDirection } from './entryState.js';
+
+/**
+ * Read the value this app left on the current history entry, and queue the value to
+ * leave on the entry the next navigation departs from.
+ *
+ * `value` is `undefined` on an ordinary forward navigation — there is no bookmark for
+ * a page being visited for the first time — and on a traversal to an entry that was
+ * stamped by nothing (a navigation the app did not initiate).
+ *
+ * `save` queues; it does not send. The queued value travels with the next
+ * `navigate()`, which is the only moment the app knows an entry is being left.
+ */
+declare const useEntryState: <T>(key: string) => {
+    value: T | undefined;
+    save: (value: T) => void;
+};
+/**
+ * How the browser reached the page being rendered: `push` for an ordinary
+ * navigation, `back`/`forward` for a history traversal.
+ *
+ * An app that resets its own view on arrival — scrolling a container to the top is
+ * the usual one — should stand down on a traversal, so a restored position is not
+ * immediately thrown away.
+ */
+declare const useNavigationDirection: () => NavigationDirection;
+
+export { useEntryState, useNavigationDirection };

package/dist/useEntryState.js

@@ -0,0 +1,17 @@
+import "./chunk-VHAA22YE.js";
+import { useCallback, useSyncExternalStore } from "react";
+import { getArrivedNavigation, saveEntryState, subscribeNavigation } from "./entryState";
+const useEntryState = (key) => {
+  const arrived = useSyncExternalStore(subscribeNavigation, getArrivedNavigation, getArrivedNavigation);
+  const save = useCallback((value) => saveEntryState(key, value), [key]);
+  return { value: arrived.state?.[key], save };
+};
+const useNavigationDirection = () => {
+  const arrived = useSyncExternalStore(subscribeNavigation, getArrivedNavigation, getArrivedNavigation);
+  return arrived.direction;
+};
+export {
+  useEntryState,
+  useNavigationDirection
+};
+//# sourceMappingURL=useEntryState.js.map

package/dist/useEntryState.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/useEntryState.ts"],"sourcesContent":["// React surface over the per-history-entry scratch (R3-627). The store itself is in\n// `entryState.ts` and is framework-free; this file is the thin binding so a component\n// re-renders when the host tells the frame which entry it just arrived at.\n\nimport { useCallback, useSyncExternalStore } from 'react';\n\nimport { getArrivedNavigation, saveEntryState, subscribeNavigation, type NavigationDirection } from './entryState';\n\n/**\n * Read the value this app left on the current history entry, and queue the value to\n * leave on the entry the next navigation departs from.\n *\n * `value` is `undefined` on an ordinary forward navigation — there is no bookmark for\n * a page being visited for the first time — and on a traversal to an entry that was\n * stamped by nothing (a navigation the app did not initiate).\n *\n * `save` queues; it does not send. The queued value travels with the next\n * `navigate()`, which is the only moment the app knows an entry is being left.\n */\nexport const useEntryState = <T>(key: string): { value: T | undefined; save: (value: T) => void } => {\n  const arrived = useSyncExternalStore(subscribeNavigation, getArrivedNavigation, getArrivedNavigation);\n  const save = useCallback((value: T) => saveEntryState(key, value), [key]);\n  return { value: arrived.state?.[key] as T | undefined, save };\n};\n\n/**\n * How the browser reached the page being rendered: `push` for an ordinary\n * navigation, `back`/`forward` for a history traversal.\n *\n * An app that resets its own view on arrival — scrolling a container to the top is\n * the usual one — should stand down on a traversal, so a restored position is not\n * immediately thrown away.\n */\nexport const useNavigationDirection = (): NavigationDirection => {\n  const arrived = useSyncExternalStore(subscribeNavigation, getArrivedNavigation, getArrivedNavigation);\n  return arrived.direction;\n};\n"],"mappings":";AAIA,SAAS,aAAa,4BAA4B;AAElD,SAAS,sBAAsB,gBAAgB,2BAAqD;AAa7F,MAAM,gBAAgB,CAAI,QAAoE;AACnG,QAAM,UAAU,qBAAqB,qBAAqB,sBAAsB,oBAAoB;AACpG,QAAM,OAAO,YAAY,CAAC,UAAa,eAAe,KAAK,KAAK,GAAG,CAAC,GAAG,CAAC;AACxE,SAAO,EAAE,OAAO,QAAQ,QAAQ,GAAG,GAAoB,KAAK;AAC9D;AAUO,MAAM,yBAAyB,MAA2B;AAC/D,QAAM,UAAU,qBAAqB,qBAAqB,sBAAsB,oBAAoB;AACpG,SAAO,QAAQ;AACjB;","names":[]}

package/dist/version.cjs

@@ -21,7 +21,7 @@ __export(version_exports, {
   SDK_VERSION: () => SDK_VERSION
 });
 module.exports = __toCommonJS(version_exports);
-const SDK_VERSION = "0.64.1";
+const SDK_VERSION = "0.65.0";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   SDK_VERSION

package/dist/version.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/version.ts"],"sourcesContent":["// GENERATED by scripts/gen-version.mjs from package.json — do not edit by hand.\n// Regenerated on every build (prebuild); kept honest by version.test.ts.\n\n/** This SDK's package version, baked from package.json at build (SP2-6). */\nexport const SDK_VERSION = '0.64.1';\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIO,MAAM,cAAc;","names":[]}
+{"version":3,"sources":["../src/version.ts"],"sourcesContent":["// GENERATED by scripts/gen-version.mjs from package.json — do not edit by hand.\n// Regenerated on every build (prebuild); kept honest by version.test.ts.\n\n/** This SDK's package version, baked from package.json at build (SP2-6). */\nexport const SDK_VERSION = '0.65.0';\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIO,MAAM,cAAc;","names":[]}

package/dist/version.d.cts

@@ -1,4 +1,4 @@
 /** This SDK's package version, baked from package.json at build (SP2-6). */
-declare const SDK_VERSION = "0.64.1";
+declare const SDK_VERSION = "0.65.0";
 
 export { SDK_VERSION };

package/dist/version.d.ts

@@ -1,4 +1,4 @@
 /** This SDK's package version, baked from package.json at build (SP2-6). */
-declare const SDK_VERSION = "0.64.1";
+declare const SDK_VERSION = "0.65.0";
 
 export { SDK_VERSION };

package/dist/version.js

@@ -1,5 +1,5 @@
 import "./chunk-VHAA22YE.js";
-const SDK_VERSION = "0.64.1";
+const SDK_VERSION = "0.65.0";
 export {
   SDK_VERSION
 };

package/dist/version.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/version.ts"],"sourcesContent":["// GENERATED by scripts/gen-version.mjs from package.json — do not edit by hand.\n// Regenerated on every build (prebuild); kept honest by version.test.ts.\n\n/** This SDK's package version, baked from package.json at build (SP2-6). */\nexport const SDK_VERSION = '0.64.1';\n"],"mappings":";AAIO,MAAM,cAAc;","names":[]}
+{"version":3,"sources":["../src/version.ts"],"sourcesContent":["// GENERATED by scripts/gen-version.mjs from package.json — do not edit by hand.\n// Regenerated on every build (prebuild); kept honest by version.test.ts.\n\n/** This SDK's package version, baked from package.json at build (SP2-6). */\nexport const SDK_VERSION = '0.65.0';\n"],"mappings":";AAIO,MAAM,cAAc;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immediately-run/sdk",
-  "version": "0.64.1",
+  "version": "0.65.0",
   "description": "Runtime SDK for code executing inside an immediately.run sandbox.",
   "license": "MIT",
   "repository": "github:immediately-run/immediately-run-sdk",