@webx-ui/module-services 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,55 @@
+# @webx-ui/module-services
+
+The front end of the services section of the [WebX UI](https://github.com/webx-ui/webx-ui) admin
+panel: a catalogue of services, and the categories they are filed under.
+
+The other half is the Composer package `webx-ui/module-services`, which owns the services, their
+addresses, their order and the API. A section appears in the panel when both halves are installed.
+
+## Install
+
+```bash
+npm install @webx-ui/module-services
+```
+
+```ts
+import { createAdmin } from '@webx-ui/module-admin'
+import { services } from '@webx-ui/module-services'
+import '@webx-ui/module-services/style.css'
+
+createAdmin({
+  basePath: '/cms',
+  modules: [...services()],
+}).mount()
+```
+
+`services()` answers with two sections — the services and their categories — because the panel
+draws one entry per module. The server puts both in the `services` group.
+`services({ path: '/catalogue' })` puts them somewhere else inside the panel.
+
+## The list
+
+The whole catalogue on one screen, without pages: a site has dozens of services, and a drag
+cannot cross a page boundary. The row shows the cover, the title with the address under it, the
+categories as chips (the first one is the main one) and the state.
+
+The list has two orders, and the filter decides which one you are dragging:
+
+- **no category chosen** — the order of the whole list;
+- **a category chosen** — the order inside that category only. Every other category keeps its own.
+
+While a search or a state narrows the list, the grips disappear: the gaps between the rows you see
+are rows you do not, and a drop into one is not an order anybody chose.
+
+## The editor
+
+The `services.form` screen, described in JSON on the server: **Content** (blocks, autosaved into
+the draft), **Settings** (title, address, categories, lead, cover, and a card for the project's own
+fields), **SEO** and **History**. The categories take effect when saved; everything else waits in
+the draft until it is published. A save over somebody else's is refused with the newer version.
+
+The categories are the panel's shared category screens with this module's words.
+
+## Licence
+
+MIT

package/dist/ServiceCreateDialog.d.ts

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

package/dist/ServiceEditorPage.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The editor of one service: a head that stays put, the described screen under it, and the bar
+ * along the bottom where it is saved and published (§4.6).
+ *
+ * Everything between the head and the bar is `services.form`, so `module-seo` adds its card and a
+ * project its price with a patch rather than a fork of this file. Saving is by autosave — a pause
+ * after the last keystroke, and the moment a field is left — into the draft; the site changes
+ * only on "Publish". Edits are guarded by a revision: a save over somebody else's is refused with
+ * a 409 and the question of which version the site gets.
+ */
+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/ServiceHistory.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, {}, HTMLDivElement>;
+export default _default;

package/dist/ServicesPage.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The catalogue: every service at once, in the order the site shows them (§4.6).
+ *
+ * No paginator and no table. There are dozens of services, not thousands, and this list is where
+ * they are put in order — a drag cannot cross a page boundary. The order is decision 5 of the
+ * spec: without a filter the rows are the whole list and a drag moves the common order; narrowed
+ * to one category they come in that category's own order and a drag moves only it; any other
+ * narrowing (a search, a status, the bin) shows a selection with invisible gaps in it, so the
+ * grips go away and the line under the list says why.
+ *
+ * A row is a card rather than a line of cells, which is what makes the same list work on a
+ * phone: the picture, the name and the address on one side, the categories and the state beside
+ * them on a wide screen and under them on a narrow one.
+ */
+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/api.d.ts

@@ -0,0 +1,33 @@
+import { AdminContext } from '@webx-ui/module-admin';
+import { ServiceDetail, ServiceInput, ServiceQuery, ServiceRow, ServiceSave, ServicesList, ServiceVersion } from './types';
+export interface ServicesApi {
+    /** Every service, with the categories the list can be narrowed to. */
+    list(query?: ServiceQuery): Promise<ServicesList>;
+    /** One service as its editor opens it: the record, the screen's values and the revision. */
+    get(id: number): Promise<ServiceDetail>;
+    create(input: ServiceInput): Promise<ServiceRow>;
+    /**
+     * Save the draft. Refused with a 409 when the revision is stale — the body is a
+     * {@link ServiceConflict} with the service as it now is.
+     */
+    save(id: number, input: ServiceSave): Promise<ServiceDetail>;
+    /** Throw away what is waiting and keep what the site is showing. */
+    discard(id: number): Promise<ServiceDetail>;
+    publish(id: number): Promise<ServiceRow>;
+    unpublish(id: number): Promise<ServiceRow>;
+    remove(id: number): Promise<void>;
+    restore(id: number): Promise<ServiceRow>;
+    /** The publications, newest first. */
+    versions(id: number): Promise<ServiceVersion[]>;
+    /** An old publication becomes the draft; putting it on the site is a separate step. */
+    restoreVersion(id: number, number: number): Promise<ServiceDetail>;
+    /** The order on screen: of the whole list, or — with `category` — of that category alone. */
+    reorder(ids: number[], category?: number | null): Promise<void>;
+}
+/** The path of the list under the panel's API, and of its order (`CategoryRoutes::items()`). */
+export declare const SERVICES_API = "services";
+/**
+ * Everything under `/services`, below the panel's API path — except the categories, which are the
+ * panel's shared ones and are asked for with `createCategoriesApi(admin, 'services/categories')`.
+ */
+export declare function createServicesApi(admin: AdminContext): ServicesApi;

package/dist/editor.d.ts

@@ -0,0 +1,19 @@
+import { InjectionKey, Ref } from 'vue';
+import { ServiceRow } from './types';
+/**
+ * What the editor knows and the nodes of `services.form` do not: the service being edited, and a
+ * way to read it again. The history needs both — its list is keyed by the service, and a restored
+ * version has to reach the fields the form is bound to.
+ */
+export interface ServiceEditorContext {
+    /** The service as the server last answered it, or `null` while the first request is out. */
+    service: Ref<ServiceRow | null>;
+    /** Whether this administrator may write at all. */
+    canManage: boolean;
+    /** Ask the server for the service again — after a restore, a publication, a discard. */
+    reload(): Promise<void>;
+}
+export declare const serviceEditorKey: InjectionKey<ServiceEditorContext>;
+export declare function provideServiceEditor(editor: ServiceEditorContext): void;
+/** The editor above this node, or `null` outside one — a demo or a test draws nothing. */
+export declare function useServiceEditor(): ServiceEditorContext | null;

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 useServicesMessages(): void;

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { services, serviceCategoriesOptions, type ServicesOptions } from './module';
+export { createServicesApi, SERVICES_API, type ServicesApi } from './api';
+export { servicesMessages } from './messages';
+export { provideServiceEditor, serviceEditorKey, useServiceEditor, type ServiceEditorContext, } from './editor';
+export { default as WxServicesPage } from './ServicesPage';
+export { default as WxServiceCreateDialog } from './ServiceCreateDialog';
+export { default as WxServiceEditorPage } from './ServiceEditorPage';
+export { default as WxServiceHistory } from './ServiceHistory';
+export type { ServiceCategoryRef, ServiceConflict, ServiceCover, ServiceDetail, ServiceInput, ServiceQuery, ServiceRow, ServiceSave, ServicesList, ServiceStatus, ServiceVersion, } from './types';