@weaver-apps/service-desk 0.1.3 → 0.3.0

package/README.md

@@ -7,10 +7,15 @@ gateway the host supplies, and holds no key.
 ## Compose it
 
 ```ts
-import { createServiceDeskPlugin, createHttpServiceDeskGateway, provideServiceDeskGateway } from '@weaver-apps/service-desk';
-
-provideTranslationNamespaces('service-desk'),
-provideCapabilityGrants({ 'service-desk': ['contributions', 'navigation', 'ui'] }),
+import {
+  createHttpServiceDeskGateway,
+  createServiceDeskPlugin,
+  provideServiceDeskGateway,
+  serviceDeskPluginId,
+} from '@weaver-apps/service-desk';
+
+provideTranslationNamespaces(serviceDeskPluginId),
+provideCapabilityGrants({ [serviceDeskPluginId]: ['contributions', 'navigation', 'ui'] }),
 ...providePlugins(createServiceDeskPlugin({ railItem: true })),
 provideServiceDeskGateway(createHttpServiceDeskGateway({ baseUrl: '/weaver-apps' })),
 ```
@@ -18,15 +23,38 @@ provideServiceDeskGateway(createHttpServiceDeskGateway({ baseUrl: '/weaver-apps'
 - `baseUrl` is a same-origin path the host's backend forwards to the server with the forwarding key and the
   signed-in person's tenant. The gateway appends the server's routes, such as
   `/service-desk/desks/{id}/requests`.
-- Serve the translations: copy `node_modules/@weaver-apps/service-desk/i18n/service-desk` to
-  `i18n/service-desk`.
-- If the host compiles the shell's theme with Tailwind, add the package as an `@source`.
-
-## Surfaces
-
-| Path | What it shows |
-|---|---|
-| `service-desk` | the tenant's desks |
-| `service-desk/:deskId` | one desk's requests, filtered and paged |
-
-`deskPath(id)` builds the second; a host that shows one entry per desk navigates there.
+- Serve the translations: copy `node_modules/@weaver-apps/service-desk/i18n/weaver-apps-service-desk` to
+  `i18n/weaver-apps-service-desk`.
+- Install AG Grid, a peer dependency the list is drawn with: `npm i ag-grid-community@^36.2 ag-grid-angular@^36.2
+  @ag-grid-community/locale@^36.2`. `@weaver-apps/data-grid`, the grid both Weaver Apps weavers share, comes along as a
+  dependency; the host composes nothing for it.
+- If the host compiles the shell's theme with Tailwind, add the package and `@weaver-apps/data-grid` as an `@source`.
+
+## Names in the host
+
+The plugin id is `weaver-apps-service-desk` (`serviceDeskPluginId`). Every id the plugin registers and every
+icon it contributes starts with `weaver-apps-service-desk.`, its routes live under
+`weaver-apps-service-desk/`, and its translations are the namespace `weaver-apps-service-desk`. The ids are
+exported as `serviceDeskContributionIds`.
+
+| Id | Path | What it shows |
+|---|---|---|
+| `weaver-apps-service-desk.desks` | `weaver-apps-service-desk` | the tenant's desks |
+| `weaver-apps-service-desk.desk` | `weaver-apps-service-desk/:deskId` | one desk's requests, filtered and paged |
+| `weaver-apps-service-desk.rail` | | the rail item, only with `railItem: true` |
+
+A desk's requests are a grid that loads more as the person scrolls and shows how many match. A click on the
+title, priority, status, raised or due header sorts them on the server (newest first by default); title and
+description, the contact, and type, status and priority filter per column, the last three by any number of values.
+By default the status filter holds open, in progress and completed.
+
+`deskPath(id)` builds the address of one desk; a host that shows one entry per desk navigates there.
+
+## Moving from 0.1.x
+
+0.2.0 draws the list with AG Grid, so a host installs it (see above). It also renamed everything the plugin puts
+into a host; a host composing it changes three places: the key of
+its capability grant (`service-desk` becomes `weaver-apps-service-desk`), the translation namespace it
+declares, and the folder it serves the translations from (`i18n/service-desk` becomes
+`i18n/weaver-apps-service-desk`). Addresses saved under `service-desk/...` no longer resolve; build them with
+`deskPath`.

package/fesm2022/weaver-apps-service-desk-desk-list-page-DPxs6zRX.mjs

@@ -0,0 +1,74 @@
+import { s as serviceDeskHost, t as SERVICE_DESK_GATEWAY } from "./weaver-apps-service-desk-service-desk-gateway-BK42Rgow.mjs";
+import { n as deskPath } from "./weaver-apps-service-desk-service-desk-paths-BmQrbz-V.mjs";
+import * as i0 from "@angular/core";
+import { CUSTOM_ELEMENTS_SCHEMA, ChangeDetectionStrategy, Component, inject, resource } from "@angular/core";
+import { TranslocoPipe } from "@jsverse/transloco";
+var DeskListPage = class DeskListPage {
+	gateway = inject(SERVICE_DESK_GATEWAY);
+	desks = resource({
+		...ngDevMode ? { debugName: "desks" } : /* istanbul ignore next */ {},
+		loader: () => this.gateway.desks()
+	});
+	open(deskId) {
+		serviceDeskHost.navigate(deskPath(deskId));
+	}
+	async create() {
+		const name = await serviceDeskHost.ui.prompt({
+			title: "weaver-apps-service-desk.desks.create",
+			message: "weaver-apps-service-desk.desks.createMessage",
+			confirmLabel: "weaver-apps-service-desk.desks.createConfirm"
+		});
+		if (!name?.trim()) return;
+		try {
+			const desk = await this.gateway.saveDesk(crypto.randomUUID(), name.trim());
+			this.open(desk.id);
+		} catch {
+			serviceDeskHost.ui.toast({
+				message: "weaver-apps-service-desk.errors.create",
+				kind: "error"
+			});
+		}
+	}
+	static ɵfac = i0.ɵɵngDeclareFactory({
+		minVersion: "12.0.0",
+		version: "22.2.3",
+		ngImport: i0,
+		type: DeskListPage,
+		deps: [],
+		target: i0.ɵɵFactoryTarget.Component
+	});
+	static ɵcmp = i0.ɵɵngDeclareComponent({
+		minVersion: "17.0.0",
+		version: "22.2.3",
+		type: DeskListPage,
+		isStandalone: true,
+		selector: "wa-desk-list-page",
+		ngImport: i0,
+		template: "<div class=\"flex h-full flex-col gap-4 overflow-auto p-6\">\n  <div class=\"flex items-center justify-between gap-4\">\n    <h2 class=\"text-lg font-semibold text-content\">{{ 'weaver-apps-service-desk.desks.title' | transloco }}</h2>\n    <button type=\"button\" class=\"lw-btn lw-btn--primary\" (click)=\"create()\">{{ 'weaver-apps-service-desk.desks.create' | transloco }}</button>\n  </div>\n  @if (desks.error()) {\n    <p class=\"text-sm text-negative\" role=\"alert\">{{ 'weaver-apps-service-desk.errors.load' | transloco }}</p>\n  } @else if (desks.hasValue()) {\n    <ul role=\"list\" class=\"divide-y divide-border rounded-xl border border-border bg-surface\">\n      @for (desk of desks.value(); track desk.id) {\n        <li>\n          <button type=\"button\" class=\"flex w-full items-center gap-3 px-4 py-3 text-left text-sm text-content hover:bg-surface-overlay\" (click)=\"open(desk.id)\">\n            <lw-icon name=\"weaver-apps-service-desk.desk\" size=\"1.25rem\"></lw-icon>\n            <span>{{ desk.name }}</span>\n          </button>\n        </li>\n      } @empty {\n        <li class=\"px-4 py-8 text-center text-sm text-content-faint\">{{ 'weaver-apps-service-desk.desks.empty' | transloco }}</li>\n      }\n    </ul>\n  }\n</div>\n",
+		dependencies: [{
+			kind: "pipe",
+			type: TranslocoPipe,
+			name: "transloco"
+		}],
+		changeDetection: i0.ChangeDetectionStrategy.OnPush
+	});
+};
+i0.ɵɵngDeclareClassMetadata({
+	minVersion: "12.0.0",
+	version: "22.2.3",
+	ngImport: i0,
+	type: DeskListPage,
+	decorators: [{
+		type: Component,
+		args: [{
+			selector: "wa-desk-list-page",
+			imports: [TranslocoPipe],
+			schemas: [CUSTOM_ELEMENTS_SCHEMA],
+			changeDetection: ChangeDetectionStrategy.OnPush,
+			template: "<div class=\"flex h-full flex-col gap-4 overflow-auto p-6\">\n  <div class=\"flex items-center justify-between gap-4\">\n    <h2 class=\"text-lg font-semibold text-content\">{{ 'weaver-apps-service-desk.desks.title' | transloco }}</h2>\n    <button type=\"button\" class=\"lw-btn lw-btn--primary\" (click)=\"create()\">{{ 'weaver-apps-service-desk.desks.create' | transloco }}</button>\n  </div>\n  @if (desks.error()) {\n    <p class=\"text-sm text-negative\" role=\"alert\">{{ 'weaver-apps-service-desk.errors.load' | transloco }}</p>\n  } @else if (desks.hasValue()) {\n    <ul role=\"list\" class=\"divide-y divide-border rounded-xl border border-border bg-surface\">\n      @for (desk of desks.value(); track desk.id) {\n        <li>\n          <button type=\"button\" class=\"flex w-full items-center gap-3 px-4 py-3 text-left text-sm text-content hover:bg-surface-overlay\" (click)=\"open(desk.id)\">\n            <lw-icon name=\"weaver-apps-service-desk.desk\" size=\"1.25rem\"></lw-icon>\n            <span>{{ desk.name }}</span>\n          </button>\n        </li>\n      } @empty {\n        <li class=\"px-4 py-8 text-center text-sm text-content-faint\">{{ 'weaver-apps-service-desk.desks.empty' | transloco }}</li>\n      }\n    </ul>\n  }\n</div>\n"
+		}]
+	}]
+});
+export { DeskListPage };
+
+//# sourceMappingURL=weaver-apps-service-desk-desk-list-page-DPxs6zRX.mjs.map

package/fesm2022/weaver-apps-service-desk-desk-list-page-DPxs6zRX.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"weaver-apps-service-desk-desk-list-page-DPxs6zRX.mjs","names":[],"sources":["../../../../libs/service-desk/src/lib/views/desk-list-page.ts","../../../../libs/service-desk/src/lib/views/desk-list-page.html"],"sourcesContent":["import { ChangeDetectionStrategy, Component, CUSTOM_ELEMENTS_SCHEMA, inject, resource } from '@angular/core';\nimport { TranslocoPipe } from '@jsverse/transloco';\nimport { SERVICE_DESK_GATEWAY } from '../gateway/service-desk-gateway';\nimport { serviceDeskHost } from '../plugin/service-desk-host';\nimport { deskPath } from '../plugin/service-desk-paths';\n\n@Component({\n  selector: 'wa-desk-list-page',\n  imports: [TranslocoPipe],\n  schemas: [CUSTOM_ELEMENTS_SCHEMA],\n  templateUrl: './desk-list-page.html',\n  changeDetection: ChangeDetectionStrategy.OnPush,\n})\nexport class DeskListPage {\n  private readonly gateway = inject(SERVICE_DESK_GATEWAY);\n\n  protected readonly desks = resource({ loader: () => this.gateway.desks() });\n\n  protected open(deskId: string): void {\n    serviceDeskHost.navigate(deskPath(deskId));\n  }\n\n  protected async create(): Promise<void> {\n    const name = await serviceDeskHost.ui.prompt({\n      title: 'weaver-apps-service-desk.desks.create',\n      message: 'weaver-apps-service-desk.desks.createMessage',\n      confirmLabel: 'weaver-apps-service-desk.desks.createConfirm',\n    });\n    if (!name?.trim()) {\n      return;\n    }\n    try {\n      const desk = await this.gateway.saveDesk(crypto.randomUUID(), name.trim());\n      this.open(desk.id);\n    } catch {\n      serviceDeskHost.ui.toast({ message: 'weaver-apps-service-desk.errors.create', kind: 'error' });\n    }\n  }\n}\n","<div class=\"flex h-full flex-col gap-4 overflow-auto p-6\">\n  <div class=\"flex items-center justify-between gap-4\">\n    <h2 class=\"text-lg font-semibold text-content\">{{ 'weaver-apps-service-desk.desks.title' | transloco }}</h2>\n    <button type=\"button\" class=\"lw-btn lw-btn--primary\" (click)=\"create()\">{{ 'weaver-apps-service-desk.desks.create' | transloco }}</button>\n  </div>\n  @if (desks.error()) {\n    <p class=\"text-sm text-negative\" role=\"alert\">{{ 'weaver-apps-service-desk.errors.load' | transloco }}</p>\n  } @else if (desks.hasValue()) {\n    <ul role=\"list\" class=\"divide-y divide-border rounded-xl border border-border bg-surface\">\n      @for (desk of desks.value(); track desk.id) {\n        <li>\n          <button type=\"button\" class=\"flex w-full items-center gap-3 px-4 py-3 text-left text-sm text-content hover:bg-surface-overlay\" (click)=\"open(desk.id)\">\n            <lw-icon name=\"weaver-apps-service-desk.desk\" size=\"1.25rem\"></lw-icon>\n            <span>{{ desk.name }}</span>\n          </button>\n        </li>\n      } @empty {\n        <li class=\"px-4 py-8 text-center text-sm text-content-faint\">{{ 'weaver-apps-service-desk.desks.empty' | transloco }}</li>\n      }\n    </ul>\n  }\n</div>\n"],"mappings":";;;;;AAaA,IAAa,eAAb,MAAa,aAAY;CACN,UAAU,OAAO,oBAAoB;CAEnC,QAAQ,SAAQ;EAAA,GAAA,YAAA,EAAA,WAAA,QAAA,+BAAA,CAAA;EAAG,cAAc,KAAK,QAAQ,MAAK;CAAE,CAAA;CAE9D,KAAK,QAAc;EAC3B,gBAAgB,SAAS,SAAS,MAAM,CAAC;CAC3C;CAEU,MAAM,SAAM;EACpB,MAAM,OAAO,MAAM,gBAAgB,GAAG,OAAO;GAC3C,OAAO;GACP,SAAS;GACT,cAAc;EACf,CAAA;EACD,IAAI,CAAC,MAAM,KAAI,GACb;EAEF,IAAI;GACF,MAAM,OAAO,MAAM,KAAK,QAAQ,SAAS,OAAO,WAAU,GAAI,KAAK,KAAI,CAAE;GACzE,KAAK,KAAK,KAAK,EAAE;EACnB,QAAQ;GACN,gBAAgB,GAAG,MAAM;IAAE,SAAS;IAA0C,MAAM;GAAO,CAAE;EAC/F;CACF;CAxBW,OAAA,OAAA,GAAA,mBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,UAAA;EAAA,MAAA;EAAY,MAAA,CAAA;EAAA,QAAA,GAAA,gBAAA;CAAA,CAAA;CAAZ,OAAA,OAAA,GAAA,qBAAA;EAAA,YAAA;EAAA,SAAA;EAAA,MAAA;EAAY,cAAA;EAAA,UAAA;EAAA,UAAA;EAAA,UCbzB;EAsBA,cAAA,CAAA;GAAA,MAAA;GAAA,MDdY;GAAa,MAAA;EAAA,CAAA;EAAA,iBAAA,GAAA,wBAAA;CAAA,CAAA;;AAKZ,GAAA,yBAAA;CAAA,YAAA;CAAA,SAAA;CAAA,UAAA;CAAA,MAAA;CAAY,YAAA,CAAA;EAPxB,MAAA;EACW,MAAA,CAAA;GAAA,UAAA;GAAmB,SACpB,CAAC,aAAa;GAAC,SACf,CAAC,sBAAsB;GAAC,iBAEhB,wBAAwB;GAAM,UAAA;EAAA,CAAA"}