mikuru 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.3
+
+- Added `mikuru/env` for package-provided `.mikuru` TypeScript declarations.
+
 ## 1.0.2
 
 - Reworked the README for npm package consumers with CLI-first setup, Vite integration, package exports, TypeScript declarations, and v1 limits.

package/README.md

@@ -20,7 +20,7 @@ npm install
 npm run dev
 ```
 
-The generated starter includes Vite, TypeScript, a `.mikuru` module declaration, and a welcome component at `src/App.mikuru`.
+The generated starter includes Vite, TypeScript, the package-provided `.mikuru` module declaration, and a welcome component at `src/App.mikuru`.
 
 ## Add Mikuru to a Vite App
 
@@ -82,26 +82,10 @@ mount(app);
 
 ## TypeScript Declarations
 
-Until Mikuru ships global `.mikuru` declarations, add a local declaration file such as `src/mikuru-env.d.ts`:
+For TypeScript projects, add a local declaration file such as `src/mikuru-env.d.ts` that imports Mikuru's package-provided `.mikuru` module declaration:
 
 ```ts
-declare module "*.mikuru" {
-  export type MikuruComponentInstance = {
-    element: Element | Comment;
-    unmount(): void;
-  };
-
-  export function mount(
-    target: Element | DocumentFragment,
-    props?: Record<string, unknown>
-  ): MikuruComponentInstance;
-
-  const component: {
-    mount: typeof mount;
-  };
-
-  export default component;
-}
+import "mikuru/env";
 ```
 
 ## Supported v1 Surface
@@ -132,6 +116,12 @@ The Vite plugin is available from `mikuru/vite`:
 import { mikuru } from "mikuru/vite";
 ```
 
+The `.mikuru` TypeScript declaration is available from `mikuru/env`:
+
+```ts
+import "mikuru/env";
+```
+
 Compiler and runtime entries are public for lower-level integrations:
 
 ```ts

package/dist/env.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/env.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=env.js.map

package/dist/env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.js","sourceRoot":"","sources":["../src/env.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mikuru",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "private": false,
   "type": "module",
   "description": "A compile-first JavaScript framework with Vue-like authoring and Svelte-like generated DOM updates.",
@@ -25,6 +25,10 @@
       "types": "./dist/runtime/index.d.ts",
       "default": "./dist/runtime/index.js"
     },
+    "./env": {
+      "types": "./types/env.d.ts",
+      "default": "./dist/env.js"
+    },
     "./vite": {
       "types": "./dist/vite.d.ts",
       "default": "./dist/vite.js"
@@ -35,6 +39,7 @@
   },
   "files": [
     "dist",
+    "types",
     "templates",
     "README.md",
     "CHANGELOG.md"

package/templates/starter/package.json

@@ -9,7 +9,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "mikuru": "^1.0.2"
+    "mikuru": "^1.0.3"
   },
   "devDependencies": {
     "typescript": "^6.0.3",

package/templates/starter/src/mikuru-env.d.ts

@@ -1,17 +1 @@
-declare module "*.mikuru" {
-  export type MikuruComponentInstance = {
-    element: Element | Comment;
-    unmount(): void;
-  };
-
-  export function mount(
-    target: Element | DocumentFragment,
-    props?: Record<string, unknown>
-  ): MikuruComponentInstance;
-
-  const component: {
-    mount: typeof mount;
-  };
-
-  export default component;
-}
+import "mikuru/env";

package/types/env.d.ts

@@ -0,0 +1,29 @@
+type EnvMikuruComponentInstance = {
+  element: Element | Comment;
+  unmount(): void;
+};
+
+type EnvMikuruMount = (
+  target: Element | DocumentFragment,
+  props?: Record<string, unknown>
+) => EnvMikuruComponentInstance;
+
+type EnvMikuruComponent = {
+  mount: EnvMikuruMount;
+};
+
+declare module "mikuru/env" {
+  export type MikuruComponentInstance = EnvMikuruComponentInstance;
+  export type MikuruMount = EnvMikuruMount;
+  export type MikuruComponent = EnvMikuruComponent;
+}
+
+declare module "*.mikuru" {
+  export function mount(
+    target: Element | DocumentFragment,
+    props?: Record<string, unknown>
+  ): EnvMikuruComponentInstance;
+
+  const component: EnvMikuruComponent;
+  export default component;
+}