@prosary/nuxt 0.0.0-stage → 0.0.0

package/.dist/runtime/side.d.mts

@@ -0,0 +1,5 @@
+/**
+ * Whether this code is running in the server render. Its own module so the
+ * one place that asks can be answered either way under test.
+ */
+export declare const onServer: () => boolean;

package/.dist/runtime/side.mjs

@@ -0,0 +1,2 @@
+const onServer = () => import.meta.server === true;
+export { onServer };

package/.dist/runtime/store.d.mts

@@ -0,0 +1,15 @@
+import { AppProsarySelection } from "./types.mjs";
+/**
+ * The per-request state and cookies the plugin and composables share. The
+ * state is the visitor's selection only — the locale and how values are
+ * formatted — so it is all the server render hands the browser; the messages
+ * are loaded on each side and never serialized into the page.
+ */
+export declare const accessProsary: () => {
+  selection: import("vue").Ref<AppProsarySelection, AppProsarySelection>;
+  cookies: {
+    locale: import("vue").Ref<string | null, string | null>;
+    timeZone: import("vue").Ref<string | null, string | null>;
+    convention: import("vue").Ref<string | null, string | null>;
+  };
+};

package/.dist/runtime/store.mjs

@@ -0,0 +1,14 @@
+import { CONVENTION_COOKIE, LOCALE_COOKIE, TIME_ZONE_COOKIE } from "../constant.mjs";
+import { useCookie, useState } from "#imports";
+import { contract } from "#build/prosary/index.mjs";
+const accessProsary = () => {
+	return {
+		selection: useState("prosary:selection", () => ({ locale: contract.locale })),
+		cookies: {
+			locale: useCookie(LOCALE_COOKIE),
+			timeZone: useCookie(TIME_ZONE_COOKIE),
+			convention: useCookie(CONVENTION_COOKIE)
+		}
+	};
+};
+export { accessProsary };

package/.dist/runtime/types.d.mts

@@ -0,0 +1,80 @@
+import { Contract, Document } from "#build/prosary/index.mjs";
+import { Bundle, Config, Key, Locale, Message, Prosary, Resolver } from "prosary";
+/**
+ * The active contract: the `Contract` the build-time `index` module declares
+ * over its locales, messages and formats.
+ */
+export type AppProsaryContract = Contract;
+/**
+ * A locale the app is built for.
+ */
+export type AppProsaryLocale = Locale<AppProsaryContract>;
+/**
+ * The key of a message of the app.
+ */
+export type AppProsaryKey = Key<AppProsaryContract>;
+/**
+ * A message of the app — its key, with the values it takes when it takes
+ * any — as data a component can be handed and resolve: `$t(message)`.
+ */
+export type AppProsaryMessage = Message<AppProsaryContract>;
+/**
+ * A content document the app is built with, by its path.
+ */
+export type AppProsaryDocument = Document;
+/**
+ * One locale's compiled messages.
+ */
+export type AppProsaryBundle = Bundle<AppProsaryContract>;
+/**
+ * The caller-owned state container the service operates on.
+ */
+export type AppProsaryConfig = Config<AppProsaryContract>;
+/**
+ * The runtime translation service bound to the app's contract.
+ */
+export type AppProsary = Prosary<AppProsaryContract>;
+/**
+ * The app's messages as functions: what `$t` is.
+ */
+export type AppProsaryResolver = Resolver<AppProsaryContract>;
+/**
+ * What a visitor has chosen, and what travels from the server render to the
+ * browser: the locale, and how values are formatted. The messages do not —
+ * each side loads the locale's bundle itself.
+ */
+export interface AppProsarySelection {
+  locale: AppProsaryLocale;
+  timeZone?: string | undefined;
+  convention?: string | undefined;
+}
+/**
+ * Switches the app to a locale: loads its bundle, then applies both in one
+ * step. Of calls that overlap, the last one made wins.
+ */
+export type SetLocale = (locale: AppProsaryLocale) => Promise<void>;
+/**
+ * The runtime hooks the service emits, keyed by event name. Shared between the
+ * `#app` augmentation and {@link ProsaryNuxtApp} so the two never drift.
+ */
+export interface ProsaryHooks {
+  "prosary:ready": (service: AppProsary) => void;
+  "prosary:locale": (locale: AppProsaryLocale) => void;
+}
+/**
+ * The minimal `nuxtApp` surface the instrumentation needs. Typing against this
+ * instead of `NuxtApp` keeps `makeProsary` off the `NuxtApp.$prosary` →
+ * `AppProsary` → `makeProsary` cycle that otherwise makes the augmentation
+ * recursive.
+ */
+export interface ProsaryNuxtApp {
+  callHook<H extends keyof ProsaryHooks>(name: H, ...args: Parameters<ProsaryHooks[H]>): unknown;
+}
+declare module "#app" {
+  interface NuxtApp {
+    $prosary: AppProsary;
+    $t: AppProsaryResolver;
+    $setLocale: SetLocale;
+  }
+  interface RuntimeNuxtHooks extends ProsaryHooks {}
+}

package/.dist/runtime/types.mjs

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

package/README.md

@@ -1,3 +1,28 @@
-# Temporary Holding Version
+# @prosary/nuxt
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Nuxt module for prosary — builds the app's messages, loads one locale per visitor, and provides `$t`.
+
+## Rendering content
+
+`useDocument(path)` loads a content document as the HTML tree the kit built,
+in the visitor's locale. `<Prose :tree>` renders it through
+[`@prosary/vue`](../vue), with the app's overrides.
+
+The overrides are the `.vue` files at the top level of `app/components/prose`
+(or the directory `components` names, relative to `app/`). Each renders the tag or directive its
+file name spells in kebab case: `H2.vue` renders every `h2`, `Callout.vue`
+every `callout` directive. A component in place of a tag receives the
+element's attributes as props and its children in the default slot; one in
+place of a directive receives the directive's attributes by the names they
+were written with. An override that names neither an element nor a directive
+the content builds fails `nuxt typecheck`.
+
+```vue
+<script setup lang="ts">
+const { data: guide } = await useDocument("guide.md");
+</script>
+
+<template>
+  <Prose v-if="guide" :tree="guide" />
+</template>
+```

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@prosary/nuxt",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.0",
+  "description": "Nuxt module for prosary \u2014 builds the app's messages, loads one locale per visitor, and provides `$t`",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zoobzio/prosary.git",
+    "directory": "integrations/nuxt"
+  },
+  "type": "module",
+  "main": "./.dist/module.mjs",
+  "types": "./.dist/module.d.mts",
+  "exports": {
+    ".": {
+      "types": "./.dist/module.d.mts",
+      "import": "./.dist/module.mjs"
+    },
+    "./config": {
+      "types": "./.dist/config.d.mts",
+      "import": "./.dist/config.mjs"
+    },
+    "./constant": {
+      "types": "./.dist/constant.d.mts",
+      "import": "./.dist/constant.mjs"
+    }
+  },
+  "files": [
+    ".dist"
+  ],
+  "scripts": {
+    "build": "obuild",
+    "stub": "obuild --stub",
+    "lint": "oxlint",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@nuxt/kit": "catalog:",
+    "@prosary/vue": "workspace:*",
+    "@types/hast": "catalog:",
+    "prosary": "workspace:*",
+    "vue": "catalog:"
+  },
+  "peerDependencies": {
+    "@prosary/kit": "workspace:*"
+  },
+  "peerDependenciesMeta": {
+    "@prosary/kit": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@prosary/kit": "workspace:*",
+    "@nuxt/nitro-server": "catalog:",
+    "@nuxt/schema": "catalog:",
+    "@types/node": "catalog:",
+    "nuxt": "catalog:"
+  }
+}