@tanstack/start-storage-context 1.129.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+<img src="https://static.scarf.sh/a.png?x-pxid=d988eb79-b0fc-4a2b-8514-6a1ab932d188" />
+
+# TanStack Start - Storage Context
+
+This package is not meant to be used directly. It is a dependency of the TanStack Start framework-specific packages:
+
+- [`@tanstack/react-start`](https://www.npmjs.com/package/@tanstack/react-start)
+- [`@tanstack/solid-start`](https://www.npmjs.com/package/@tanstack/solid-start).
+
+It provides the core functionality for TanStack Start, which is a fullstack-framework made for SSR, Streaming, Server Functions, API Routes, bundling and more powered by [TanStack Router](https://tanstack.com/router).
+
+Head over to [tanstack.com/start](https://tanstack.com/start) for more information about getting started.

package/dist/cjs/async-local-storage.cjs

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const node_async_hooks = require("node:async_hooks");
+const startStorage = new node_async_hooks.AsyncLocalStorage();
+async function runWithStartContext(context, fn) {
+  return startStorage.run(context, fn);
+}
+function getStartContext(opts) {
+  const context = startStorage.getStore();
+  if (!context && (opts == null ? void 0 : opts.throwIfNotFound) !== false) {
+    throw new Error(
+      `No Start context found in AsyncLocalStorage. Make sure you are using the function within the server runtime.`
+    );
+  }
+  return context;
+}
+exports.getStartContext = getStartContext;
+exports.runWithStartContext = runWithStartContext;
+//# sourceMappingURL=async-local-storage.cjs.map

package/dist/cjs/async-local-storage.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-local-storage.cjs","sources":["../../src/async-local-storage.ts"],"sourcesContent":["import { AsyncLocalStorage } from 'node:async_hooks'\nimport type { AnyRouter } from '@tanstack/router-core'\n\nexport interface StartStorageContext {\n  router: AnyRouter\n}\n\nconst startStorage = new AsyncLocalStorage<StartStorageContext>()\n\nexport async function runWithStartContext<T>(\n  context: StartStorageContext,\n  fn: () => T | Promise<T>,\n): Promise<T> {\n  return startStorage.run(context, fn)\n}\n\nexport function getStartContext<TThrow extends boolean = true>(opts?: {\n  throwIfNotFound?: TThrow\n}): TThrow extends false\n  ? StartStorageContext | undefined\n  : StartStorageContext {\n  const context = startStorage.getStore()\n  if (!context && opts?.throwIfNotFound !== false) {\n    throw new Error(\n      `No Start context found in AsyncLocalStorage. Make sure you are using the function within the server runtime.`,\n    )\n  }\n  return context as any\n}\n"],"names":["AsyncLocalStorage"],"mappings":";;;AAOA,MAAM,eAAe,IAAIA,iBAAAA,kBAAuC;AAE1C,eAAA,oBACpB,SACA,IACY;AACL,SAAA,aAAa,IAAI,SAAS,EAAE;AACrC;AAEO,SAAS,gBAA+C,MAIvC;AAChB,QAAA,UAAU,aAAa,SAAS;AACtC,MAAI,CAAC,YAAW,6BAAM,qBAAoB,OAAO;AAC/C,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EAAA;AAEK,SAAA;AACT;;;"}

package/dist/cjs/async-local-storage.d.cts

@@ -0,0 +1,8 @@
+import { AnyRouter } from '@tanstack/router-core';
+export interface StartStorageContext {
+    router: AnyRouter;
+}
+export declare function runWithStartContext<T>(context: StartStorageContext, fn: () => T | Promise<T>): Promise<T>;
+export declare function getStartContext<TThrow extends boolean = true>(opts?: {
+    throwIfNotFound?: TThrow;
+}): TThrow extends false ? StartStorageContext | undefined : StartStorageContext;

package/dist/cjs/index.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const asyncLocalStorage = require("./async-local-storage.cjs");
+exports.getStartContext = asyncLocalStorage.getStartContext;
+exports.runWithStartContext = asyncLocalStorage.runWithStartContext;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/cjs/index.d.cts

@@ -0,0 +1,2 @@
+export { getStartContext, runWithStartContext } from './async-local-storage.cjs';
+export type { StartStorageContext } from './async-local-storage.cjs';

package/dist/esm/async-local-storage.d.ts

@@ -0,0 +1,8 @@
+import { AnyRouter } from '@tanstack/router-core';
+export interface StartStorageContext {
+    router: AnyRouter;
+}
+export declare function runWithStartContext<T>(context: StartStorageContext, fn: () => T | Promise<T>): Promise<T>;
+export declare function getStartContext<TThrow extends boolean = true>(opts?: {
+    throwIfNotFound?: TThrow;
+}): TThrow extends false ? StartStorageContext | undefined : StartStorageContext;

package/dist/esm/async-local-storage.js

@@ -0,0 +1,19 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+const startStorage = new AsyncLocalStorage();
+async function runWithStartContext(context, fn) {
+  return startStorage.run(context, fn);
+}
+function getStartContext(opts) {
+  const context = startStorage.getStore();
+  if (!context && (opts == null ? void 0 : opts.throwIfNotFound) !== false) {
+    throw new Error(
+      `No Start context found in AsyncLocalStorage. Make sure you are using the function within the server runtime.`
+    );
+  }
+  return context;
+}
+export {
+  getStartContext,
+  runWithStartContext
+};
+//# sourceMappingURL=async-local-storage.js.map

package/dist/esm/async-local-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-local-storage.js","sources":["../../src/async-local-storage.ts"],"sourcesContent":["import { AsyncLocalStorage } from 'node:async_hooks'\nimport type { AnyRouter } from '@tanstack/router-core'\n\nexport interface StartStorageContext {\n  router: AnyRouter\n}\n\nconst startStorage = new AsyncLocalStorage<StartStorageContext>()\n\nexport async function runWithStartContext<T>(\n  context: StartStorageContext,\n  fn: () => T | Promise<T>,\n): Promise<T> {\n  return startStorage.run(context, fn)\n}\n\nexport function getStartContext<TThrow extends boolean = true>(opts?: {\n  throwIfNotFound?: TThrow\n}): TThrow extends false\n  ? StartStorageContext | undefined\n  : StartStorageContext {\n  const context = startStorage.getStore()\n  if (!context && opts?.throwIfNotFound !== false) {\n    throw new Error(\n      `No Start context found in AsyncLocalStorage. Make sure you are using the function within the server runtime.`,\n    )\n  }\n  return context as any\n}\n"],"names":[],"mappings":";AAOA,MAAM,eAAe,IAAI,kBAAuC;AAE1C,eAAA,oBACpB,SACA,IACY;AACL,SAAA,aAAa,IAAI,SAAS,EAAE;AACrC;AAEO,SAAS,gBAA+C,MAIvC;AAChB,QAAA,UAAU,aAAa,SAAS;AACtC,MAAI,CAAC,YAAW,6BAAM,qBAAoB,OAAO;AAC/C,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EAAA;AAEK,SAAA;AACT;"}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export { getStartContext, runWithStartContext } from './async-local-storage.js';
+export type { StartStorageContext } from './async-local-storage.js';

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+import { getStartContext, runWithStartContext } from "./async-local-storage.js";
+export {
+  getStartContext,
+  runWithStartContext
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@tanstack/start-storage-context",
+  "version": "1.129.0",
+  "description": "Modern and scalable routing for React applications",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TanStack/router.git",
+    "directory": "packages/start-storage-context"
+  },
+  "homepage": "https://tanstack.com/start",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "keywords": [
+    "react",
+    "location",
+    "router",
+    "routing",
+    "async",
+    "async router",
+    "typescript"
+  ],
+  "type": "module",
+  "types": "dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "dependencies": {
+    "@tanstack/router-core": "1.129.0"
+  },
+  "scripts": {}
+}

package/src/async-local-storage.ts

@@ -0,0 +1,29 @@
+import { AsyncLocalStorage } from 'node:async_hooks'
+import type { AnyRouter } from '@tanstack/router-core'
+
+export interface StartStorageContext {
+  router: AnyRouter
+}
+
+const startStorage = new AsyncLocalStorage<StartStorageContext>()
+
+export async function runWithStartContext<T>(
+  context: StartStorageContext,
+  fn: () => T | Promise<T>,
+): Promise<T> {
+  return startStorage.run(context, fn)
+}
+
+export function getStartContext<TThrow extends boolean = true>(opts?: {
+  throwIfNotFound?: TThrow
+}): TThrow extends false
+  ? StartStorageContext | undefined
+  : StartStorageContext {
+  const context = startStorage.getStore()
+  if (!context && opts?.throwIfNotFound !== false) {
+    throw new Error(
+      `No Start context found in AsyncLocalStorage. Make sure you are using the function within the server runtime.`,
+    )
+  }
+  return context as any
+}

package/src/index.tsx

@@ -0,0 +1,2 @@
+export { getStartContext, runWithStartContext } from './async-local-storage'
+export type { StartStorageContext } from './async-local-storage'