@webx-ui/module-seo 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 webx-ui
+
+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,58 @@
+# @webx-ui/module-seo
+
+SEO as a section of the [WebX UI](https://github.com/webx-ui/webx-ui) admin panel: the rules
+written for addresses, the addresses that have moved, and the card that edits what a page says
+about itself.
+
+The other half is `webx-ui/module-seo` on the server, which is what actually prints a `<head>`.
+Neither is useful alone.
+
+## Install
+
+```bash
+pnpm add @webx-ui/module-seo
+```
+
+```ts
+import { createAdmin } from '@webx-ui/module-admin'
+import { WxMediaField } from '@webx-ui/module-media'
+import { seo } from '@webx-ui/module-seo'
+import '@webx-ui/module-seo/style.css'
+
+createAdmin({
+  modules: [seo({ mediaField: WxMediaField })],
+})
+```
+
+The section appears under **System** once the Composer half is installed and migrated.
+Permissions: `seo.view`, `seo.manage`.
+
+`mediaField` is handed in rather than imported, so this package does not depend on the media
+library being installed — without it every other SEO field still works and only the share image
+is missing.
+
+## What it brings
+
+- `/seo` — the rules, listed in the order the site tries them.
+- `/seo/redirects` — the addresses that have moved, busiest first.
+- **Check an address** — which redirect catches it, which rule matched, what every source
+  contributed, and what the page ends up saying. One call instead of a reading of the code.
+- `wx-seo` — a field type any screen can use, whose value is everything a page says about itself
+  as one object. `WxSeo` is exported directly for a form that would rather place it by hand.
+
+## Talking to it directly
+
+```ts
+import { createSeoApi } from '@webx-ui/module-seo'
+
+const api = createSeoApi(useAdmin())
+
+await api.urls({ q: '/catalog' })
+await api.test('/catalog/shoes?page=2')
+```
+
+The guide is at [webx-ui.github.io/webx-ui/guide/seo](https://webx-ui.github.io/webx-ui/guide/seo.html).
+
+## License
+
+MIT.

package/dist/SeoCard.d.ts

@@ -0,0 +1,38 @@
+import { Component } from 'vue';
+import { SeoValue } from './types';
+type __VLS_Props = {
+    /**
+     * The field that picks the share image — `WxMediaField` in a panel that has the library.
+     *
+     * Handed in rather than imported: this package does not depend on the media one, and a panel
+     * without a library still edits everything else about a page.
+     */
+    mediaField?: Component;
+    disabled?: boolean;
+    /**
+     * Soft limits, for the counters only. Long is not wrong — search engines shorten what they
+     * shorten — so nothing here refuses a longer line, it only says how long it is.
+     */
+    titleLimit?: number;
+    descriptionLimit?: number;
+    /** What the snippet preview shows above the title. */
+    site?: string;
+    /** Hidden when a screen has no use for them. */
+    structuredData?: boolean;
+};
+type __VLS_PublicProps = {
+    modelValue?: SeoValue | null;
+} & __VLS_Props;
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: Partial<import('./types').SeoFields> | null) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: Partial<import('./types').SeoFields> | null) => any) | undefined;
+}>, {
+    mediaField: Component;
+    disabled: boolean;
+    titleLimit: number;
+    descriptionLimit: number;
+    site: string;
+    structuredData: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/SeoLayout.d.ts

@@ -0,0 +1,33 @@
+/**
+ * The head of the section: its name, the switch between what it holds, and the one tool that
+ * belongs to the whole of it.
+ *
+ * Rules and redirects are two screens rather than two tabs of one, because they are two tables
+ * with their own paging and their own search — and a tab that quietly resets both when you come
+ * back to it is worse than a second address.
+ */
+type __VLS_Props = {
+    base: string;
+    current: 'rules' | 'redirects';
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    test: () => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onTest?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/SeoRedirectDialog.d.ts

@@ -0,0 +1,9 @@
+import { SeoRedirect } from './types';
+/** One address that has moved, and where to. Four fields, so four fields. */
+type __VLS_Props = {
+    redirect?: SeoRedirect | null;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    redirect: SeoRedirect | null;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/SeoRedirectsPage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The addresses that have moved.
+ *
+ * Busiest first by default, which is the order this list is worked on: a redirect nobody has
+ * followed since the site was rebuilt is the one worth deleting, and it sits at the bottom.
+ */
+type __VLS_Props = {
+    base?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    base: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/SeoUrlDialog.d.ts

@@ -0,0 +1,19 @@
+import { Component } from 'vue';
+import { SeoUrlRule } from './types';
+/**
+ * One rule: which addresses it covers, and what it says about them.
+ *
+ * A dialog rather than a second route, and a template rather than a described screen — the same
+ * decision `admins.form` is on, until the screens mechanism has been round the block a few more
+ * times. What it edits below the address is `WxSeo`, the same card a content module will get by
+ * patching it into its own form.
+ */
+type __VLS_Props = {
+    rule?: SeoUrlRule | null;
+    mediaField?: Component;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    rule: SeoUrlRule | null;
+    mediaField: Component;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/SeoUrlsPage.d.ts

@@ -0,0 +1,17 @@
+import { Component } from 'vue';
+/**
+ * The rules written for addresses.
+ *
+ * Listed in the order the site tries them — exact, then mask, then regular expression, by
+ * priority inside each group — so that reading the table top to bottom is reading what will
+ * happen. Sorting it any other way would hide the one thing a person comes here to work out.
+ */
+type __VLS_Props = {
+    base?: string;
+    mediaField?: Component;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    mediaField: Component;
+    base: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/TestUrlDialog.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/api.d.ts

@@ -0,0 +1,18 @@
+import { AdminContext } from '@webx-ui/module-admin';
+import { SeoPage, SeoRedirect, SeoRedirectInput, SeoRedirectQuery, SeoTestResult, SeoUrlInput, SeoUrlQuery, SeoUrlRule } from './types';
+export interface SeoApi {
+    /** The rules, in the order the site tries them. */
+    urls(query?: SeoUrlQuery): Promise<SeoPage<SeoUrlRule>>;
+    url(id: number): Promise<SeoUrlRule>;
+    createUrl(input: SeoUrlInput): Promise<SeoUrlRule>;
+    updateUrl(id: number, input: SeoUrlInput): Promise<SeoUrlRule>;
+    removeUrl(id: number): Promise<void>;
+    redirects(query?: SeoRedirectQuery): Promise<SeoPage<SeoRedirect>>;
+    createRedirect(input: SeoRedirectInput): Promise<SeoRedirect>;
+    updateRedirect(id: number, input: SeoRedirectInput): Promise<SeoRedirect>;
+    removeRedirect(id: number): Promise<void>;
+    /** What an address ends up saying, and where every part of it came from. */
+    test(url: string, locale?: string | null): Promise<SeoTestResult>;
+}
+/** Everything under `/seo`, below the panel's API path. */
+export declare function createSeoApi(admin: AdminContext): SeoApi;

package/dist/i18n.d.ts

@@ -0,0 +1,2 @@
+/** Puts this package's English under the panel's dictionary, once per panel. */
+export declare function useSeoMessages(): void;

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { seo, type SeoOptions } from './module';
+export { createSeoApi, type SeoApi } from './api';
+export { seoMessages } from './messages';
+export { ruleInput, ruleTitle, seoOf } from './rule';
+export { default as WxSeo } from './SeoCard';
+export { default as WxSeoUrlsPage } from './SeoUrlsPage';
+export { default as WxSeoRedirectsPage } from './SeoRedirectsPage';
+export type { MatchType, RobotsDirective, SeoChainStep, SeoFields, SeoImage, SeoPage, SeoRedirect, SeoRedirectInput, SeoRedirectQuery, SeoResolved, SeoTestResult, SeoUrlInput, SeoUrlQuery, SeoUrlRule, SeoValue, } from './types';
+export { robotsDirectives } from './types';