@studiocms/cfetch 0.1.4 → 0.1.5

package/README.md

@@ -3,6 +3,7 @@
 ![Readme's Banner](https://github.com/withstudiocms/cfetch/blob/main/assets/cfetch-banner.png)
 
 [![NPM Version](https://img.shields.io/npm/v/@studiocms/cfetch?logo=npm)](https://npm.im/@studiocms/cfetch)
+[![JSR](https://jsr.io/badges/@studiocms/cfetch)](https://jsr.io/@studiocms/cfetch)
 [![Formatted with Biome](https://img.shields.io/badge/Formatted_with-Biome-60a5fa?style=flat&logo=biome)](https://biomejs.dev/)
 [![Built with Astro](https://astro.badg.es/v2/built-with-astro/tiny.svg)](https://astro.build)
 

package/dist/consts.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This module contains constants for cFetch
+ * @module
+ */
 import type { CacheConfig } from './types.js';
 /**
  * Default cache configuration object.

package/dist/index.d.ts

@@ -1,4 +1,7 @@
-/// <reference types="./cache.d.ts" preserve="true" />
+/**
+ * This module contains the AstroIntegration for cFetch
+ * @module
+ */
 import type { AstroIntegration } from 'astro';
 import type { CacheConfig } from './types.js';
 /**
@@ -32,5 +35,5 @@ import type { CacheConfig } from './types.js';
  * // Use the data in your component
  * ```
  */
-export declare function astroCache(opts?: CacheConfig): AstroIntegration;
-export default astroCache;
+export declare function cFetch(opts?: CacheConfig): AstroIntegration;
+export default cFetch;

package/dist/index.js

@@ -1,6 +1,7 @@
 import { defaultConfig } from "./consts.js";
+import stub from "./stub.js";
 import { addVirtualImports, createResolver } from "./utils/integration.js";
-function astroCache(opts) {
+function cFetch(opts) {
   const name = "@studiocms/cfetch";
   const { resolve } = createResolver(import.meta.url);
   const options = {
@@ -18,12 +19,18 @@ function astroCache(opts) {
             "c:fetch": `export * from '${resolve("./wrappers.js")}';`
           }
         });
+      },
+      "astro:config:done": ({ injectTypes }) => {
+        injectTypes({
+          filename: "cfetch.d.ts",
+          content: stub
+        });
       }
     }
   };
 }
-var index_default = astroCache;
+var index_default = cFetch;
 export {
-  astroCache,
+  cFetch,
   index_default as default
 };

package/dist/stub.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This module contains a stub file for type generation
+ * @module
+ */
+declare const stub: string;
+export default stub;

package/dist/{cache.d.ts → stub.js}

@@ -1,32 +1,35 @@
+import { createResolver } from "./utils/integration.js";
+const { resolve } = createResolver(import.meta.url);
+const stub = `
 declare module 'virtual:cfetch/config' {
 	/**
 	 * Default configuration for the cache passed from the user.
 	 *
 	 * @property lifetime - Specifies the duration for which the cache is valid.
 	 *                       The format should be a template literal string representing
-	 *                       either minutes (`<number>m`) or hours (`<number>h`).
+	 *                       either minutes (\`<number>m\`) or hours (\`<number>h\`).
 	 *                       For example: "5m" for 5 minutes or "2h" for 2 hours.
 	 */
-	const defaultConfig: import('./types').CacheConfig;
+	const defaultConfig: import(${resolve("./types")}).CacheConfig;
 	export default defaultConfig;
 }
 
 declare module 'c:fetch' {
 	/**
-	 * Represents the type of the global `fetch` function.
+	 * Represents the type of the global \`fetch\` function.
 	 *
-	 * This type is derived from the built-in `fetch` function, allowing you to
-	 * use it as a reference for type-safe operations involving `fetch`.
+	 * This type is derived from the built-in \`fetch\` function, allowing you to
+	 * use it as a reference for type-safe operations involving \`fetch\`.
 	 */
 	type FetchType = typeof fetch;
 	/**
-	 * Represents the input parameter type for the `FetchType` function.
-	 * This type is derived from the first parameter of the `FetchType` function.
+	 * Represents the input parameter type for the \`FetchType\` function.
+	 * This type is derived from the first parameter of the \`FetchType\` function.
 	 */
 	type Input = Parameters<FetchType>[0];
 	/**
-	 * Represents the `init` parameter of the `fetch` function, which is the second parameter
-	 * in the `FetchType` function signature. This type is used to configure the request,
+	 * Represents the \`init\` parameter of the\`fetch\` function, which is the second parameter
+	 * in the \`FetchType\` function signature. This type is used to configure the request,
 	 * including options such as method, headers, body, and other settings.
 	 */
 	type Init = Parameters<FetchType>[1];
@@ -42,17 +45,17 @@ declare module 'c:fetch' {
 	 *
 	 * @property lifetime - Specifies the duration for which the cache is valid.
 	 *                       The format should be a template literal string representing
-	 *                       either minutes (`<number>m`) or hours (`<number>h`).
+	 *                       either minutes (\`<number>m\`) or hours (\`<number>h\`).
 	 *                       For example: "5m" for 5 minutes or "2h" for 2 hours.
 	 */
 	export interface CacheConfig {
 		/**
 		 * Specifies the duration for which the cache is valid.
 		 *     The format should be a template literal string representing
-		 *     either minutes (`<number>m`) or hours (`<number>h`).
+		 *     either minutes (\`<number>m\`) or hours (\`<number>h\`).
 		 *     For example: "5m" for 5 minutes or "2h" for 2 hours.
 		 */
-		lifetime: `${number}m` | `${number}h`;
+		lifetime: \`<number>m\` | \`<number>h\`;
 	}
 	/**
 	 * Fetches data with caching capabilities. If the data is not present in the cache
@@ -61,13 +64,13 @@ declare module 'c:fetch' {
 	 *
 	 * @param input - The input to the fetch function, typically a URL or Request object.
 	 * @param init - An optional configuration object for the fetch request.
-	 * @param cacheConfig - Partial configuration for the cache behavior. Defaults to `defaultConfig`.
+	 * @param cacheConfig - Partial configuration for the cache behavior. Defaults to \`defaultConfig\`.
 	 * @param  type - Optional parameter specifying the expected response body format.
 	 *              Can be either 'json' or 'text'. Determines how the response body is processed.
 	 * @param metadata - A boolean indicating whether to return the full cached object (including metadata)
-	 *               or just the data. Defaults to `false`.
-	 * @returns The fetched or cached data. If `full` is `true`, returns an object containing
-	 *          both the data and metadata (e.g., `lastCheck`).
+	 *               or just the data. Defaults to \`false\`.
+	 * @returns The fetched or cached data. If \`full\` is \`true\`, returns an object containing
+	 *          both the data and metadata (e.g., \`lastCheck\`).
 	 * @throws An error if fetching new data fails and no cached data is available.
 	 */
 	export function cFetch(
@@ -84,3 +87,9 @@ declare module 'c:fetch' {
 		metadata?: boolean
 	): Promise<CacheDataValue>;
 }
+
+`;
+var stub_default = stub;
+export {
+  stub_default as default
+};

package/dist/types.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This module contains types for the cfetch package
+ * @module
+ */
 /**
  * Represents the type of the global `fetch` function.
  *

package/dist/utils/integration.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This module contains Astro Integration Utilities
+ * @module
+ */
 import type path from 'node:path';
 import type { HookParameters } from 'astro';
 import type { PluginOption } from 'vite';

package/dist/utils/isOlderThan.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This module contains helper functions for cFetch
+ * @module
+ */
 /**
  * Determines whether a given date is older than a specified lifetime.
  *

package/dist/wrappers.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This module contains functions that wrap and cache the native fetch function
+ * @module
+ */
 import type { CacheConfig, CacheDataValue, Init, Input } from './types.js';
 export type { CacheConfig };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiocms/cfetch",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Astro integration that allows you to have a cached fetch function in your Astro SSR project.",
   "license": "MIT",
   "homepage": "https://studiocms.dev",
@@ -47,13 +47,13 @@
     "./types": {
       "types": "./dist/types.d.ts",
       "default": "./dist/types.js"
-    },
-    "./v/types": "./dist/cache.d.ts"
+    }
   },
   "devDependencies": {
     "@inox-tools/astro-tests": "^0.5.1",
     "@types/node": "^22.0.0",
-    "jest-extended": "^4.0.2"
+    "jest-extended": "^4.0.2",
+    "astro": "^5.5"
   },
   "peerDependencies": {
     "astro": "^5.5",