image-renditions 0.5.0 → 0.6.0

package/README.md

@@ -278,16 +278,17 @@ For such a path, `<RenditionImg>` and `useRenditions()` give the URL of the sour
 - Changing `originals` keeps the hashes of the preset.
 
 Only the app knows where its sources are served from, so it builds their URLs.
-Set the module option `originalUrl` to a module whose default export is a composable returning a function from the scope and the logical path to the URL:
+Set the module option `originalUrl` to a module whose default export is a composable returning a function from the scope and the logical path to the URL.
+`defineRenditionOriginalUrl()`, which the module auto-imports, types them by the catalog:
 
 ```ts
 // app/renditions/original-url.ts
-import { encodePath, type RenditionTarget } from "image-renditions"
+import { encodePath } from "image-renditions"
 
-export default function useOriginalUrl() {
+export default defineRenditionOriginalUrl(() => {
   const { uploadsUrl } = useRuntimeConfig().public
-  return ({ path }: RenditionTarget) => `${uploadsUrl}/${encodePath(path)}`
-}
+  return ({ path }) => `${uploadsUrl}/${encodePath(path)}`
+})
 ```
 
 ```ts

package/dist/nuxt/runtime.d.mts

@@ -1,4 +1,4 @@
-import { a as RenditionTarget, t as Catalog } from "../catalog-6wdmwTO7.mjs";
+import { a as RenditionTarget, s as ScopeName, t as Catalog } from "../catalog-6wdmwTO7.mjs";
 import { PropType } from "vue";
 //#region src/nuxt/runtime.d.ts
 /** Attributes of an `img` element showing a rendition. */
@@ -34,6 +34,22 @@ export interface RenditionAttrsOptions<Scope extends string = string> {
   /** Whether to set `width` and `height`; `false` leaves the size to a component that sizes the image itself. */
   size?: boolean;
 }
+/**
+ * Registry of the catalog the Nuxt module serves, which the module fills with the type of its catalog.
+ *
+ * It types helpers defined in files of the application, such as {@link defineRenditionOriginalUrl}.
+ */
+export interface RenditionRegister {}
+/** Scope of the catalog in {@link RenditionRegister}, or any string without one. */
+type RegisteredScope = RenditionRegister extends {
+  catalog: infer C extends Pick<Catalog, "scopes">;
+} ? ScopeName<C> : string;
+/**
+ * Defines the composable of the `originalUrl` module option, typing its targets by the catalog of the Nuxt module.
+ *
+ * The Nuxt module auto-imports it.
+ */
+export declare function defineRenditionOriginalUrl(useOriginalUrl: () => (target: RenditionTarget<RegisteredScope>) => string): () => (target: RenditionTarget<RegisteredScope>) => string;
 /** Options of {@link createRenditionHelpers}. */
 export interface RenditionHelpersOptions<Scope extends string = string> {
   /** Scope of calls that set none. */
@@ -94,4 +110,5 @@ export declare function createRenditionHelpers<Name extends string, Scope extend
     scope: unknown extends Scope ? keyof Scope extends never ? undefined : Scope : Scope;
   }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 };
-//#endregion
+//#endregion
+export {};

package/dist/nuxt/runtime.mjs

@@ -6,6 +6,14 @@ import { useRuntimeConfig } from "nuxt/app";
 import { defineComponent, h } from "vue";
 //#region src/nuxt/runtime.ts
 /**
+* Defines the composable of the `originalUrl` module option, typing its targets by the catalog of the Nuxt module.
+*
+* The Nuxt module auto-imports it.
+*/
+function defineRenditionOriginalUrl(useOriginalUrl) {
+	return useOriginalUrl;
+}
+/**
 * Binds `useRenditions()` and `<RenditionImg>` to a catalog.
 *
 * The Nuxt module calls it in a generated module; applications use the generated helpers.
@@ -150,4 +158,4 @@ function createRenditionHelpers(catalog, { defaultScope, useOriginalUrl, imgAttr
 	};
 }
 //#endregion
-export { createRenditionHelpers };
+export { createRenditionHelpers, defineRenditionOriginalUrl };

package/dist/nuxt.mjs

@@ -2,7 +2,7 @@ import { r as isSafeScope } from "./path-hNFUjCbA.mjs";
 import { n as isDeclaredScope } from "./scopes-C1kzqQHz.mjs";
 import { t as findRenditionAttr } from "./img-attrs-BoCAHpl5.mjs";
 import { createJiti } from "jiti";
-import { addComponent, addImports, addServerHandler, addTemplate, defineNuxtModule, resolvePath } from "nuxt/kit";
+import { addComponent, addImports, addServerHandler, addTemplate, addTypeTemplate, defineNuxtModule, resolvePath } from "nuxt/kit";
 //#region src/nuxt/module.ts
 /**
 * Nuxt module that mounts the rendition handler and provides `useRenditions()` and `<RenditionImg>` typed by the catalog.
@@ -46,6 +46,28 @@ const module = defineNuxtModule({
 			name: "useRenditions",
 			from: template.dst
 		});
+		addTypeTemplate({
+			filename: "types/image-renditions.d.ts",
+			getContents: () => [
+				`declare module "image-renditions/nuxt/runtime" {`,
+				`  interface RenditionRegister {`,
+				`    catalog: typeof import(${formatImportSpecifier(catalogPath)}).default`,
+				`  }`,
+				`}`,
+				"",
+				"export {}",
+				""
+			].join("\n")
+		});
+		const defineTemplate = addTemplate({
+			filename: "image-renditions-define.ts",
+			write: true,
+			getContents: () => `export { defineRenditionOriginalUrl } from "image-renditions/nuxt/runtime"\n`
+		});
+		addImports({
+			name: "defineRenditionOriginalUrl",
+			from: defineTemplate.dst
+		});
 		addComponent({
 			name: "RenditionImg",
 			export: "RenditionImg",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "image-renditions",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "On-demand image transformations that persist every result to durable storage and keep app servers stateless.",
   "homepage": "https://github.com/IlyaSemenov/image-renditions#readme",
   "bugs": "https://github.com/IlyaSemenov/image-renditions/issues",