@orthacms/users-admin 0.0.0-reserve.0

package/dist/lib/presentation/usersPlugin/index.js

@@ -0,0 +1,109 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Suspense, lazy } from 'react';
+import { SIDEBAR_FOOTER_SLOT, SIDEBAR_NAV_SLOT } from '@orthacms/shell-admin';
+import { Users } from 'lucide-react';
+import { InviteMemberPageSkeleton, MembersPageSkeleton } from '../components/MembersSkeleton';
+import { AccountMenu } from '../components/AccountMenu';
+import { ThemeSync } from '../components/ThemeSync';
+// Lazy-loaded so the Members page is code-split into its own chunk, fetched
+// only when a signed-in user first navigates to `/users`.
+const MembersPage = lazy(() => import('../pages/MembersPage').then((module) => ({
+    default: module.MembersPage
+})));
+const InviteMemberPage = lazy(() => import('../pages/InviteMemberPage').then((module) => ({
+    default: module.InviteMemberPage
+})));
+// The detail page (its nested tab router) is its own chunk, fetched only when a
+// member row is opened.
+const UserDetailRouter = lazy(() => import('../components/UserDetailRouter').then((module) => ({
+    default: module.UserDetailRouter
+})));
+/**
+ * Creates the admin-side users plugin. It owns the members feature: the
+ * private `/users` route (the Members page, rendered inside the shell's
+ * authenticated layout) and its toolbar nav entry, contributed to the shell's
+ * {@link NAVBAR_START_SLOT} at `order: 30` (after Workspaces). The page itself
+ * gates on the `users:read` permission.
+ *
+ * @example
+ * ```typescript
+ * createAdmin({
+ *   plugins: [
+ *     IdentityPlugin(),
+ *     ShellPlugin(),
+ *     WorkspacesPlugin(),
+ *     UsersPlugin(),
+ *   ],
+ * });
+ * ```
+ */
+export function UsersPlugin() {
+    return {
+        name: 'users',
+        routes: [
+            {
+                path: '/users',
+                element: (_jsx(Suspense, { fallback: _jsx(MembersPageSkeleton, {}), children: _jsx(MembersPage, {}) }))
+            },
+            {
+                path: '/users/invite',
+                element: (_jsx(Suspense, { fallback: _jsx(InviteMemberPageSkeleton, {}), children: _jsx(InviteMemberPage, {}) }))
+            },
+            {
+                // Splat so the detail page owns its nested tab routes
+                // (`general`, `roles`, …). `/users/invite` outranks `/users/:id`
+                // in the router, so the static invite route is unaffected.
+                path: '/users/:id/*',
+                element: (_jsx(Suspense, { fallback: _jsx(MembersPageSkeleton, {}), children: _jsx(UserDetailRouter, {}) }))
+            }
+        ],
+        slots: [
+            {
+                slot: SIDEBAR_NAV_SLOT,
+                items: [
+                    {
+                        labelId: 'users.nav.label',
+                        defaultLabel: 'Members',
+                        to: '/users',
+                        group: 'directory',
+                        order: 20,
+                        icon: Users,
+                        iconColor: 'text-nav-green',
+                        // Without this the entry is a dead link for anyone who
+                        // can't read the directory: the page renders its
+                        // no-access state, so the nav promises a destination it
+                        // won't deliver. The sibling plugins gate the same way
+                        // (`activity:read`, `tokens:read`).
+                        permission: 'users:read'
+                    }
+                ]
+            },
+            {
+                // The account menu pinned to the sidebar footer, plus an
+                // invisible theme hydrator (renders null) that pulls the
+                // signed-in user's saved theme from the server so it takes
+                // effect app-wide without opening the Preferences tab.
+                //
+                // The hydrator lives in the FOOTER, not SIDEBAR_SECTION_SLOT:
+                // the section slot belongs to `GlobalSidebar`, which a route can
+                // replace wholesale via `useSidebarContent` (the workspace shell
+                // does). Mounted there, a user who deep-links straight into a
+                // workspace route would never hydrate their theme. The footer is
+                // the region the shell keeps mounted in *both* contexts.
+                slot: SIDEBAR_FOOTER_SLOT,
+                items: [
+                    {
+                        id: 'users.themeSync',
+                        order: 0,
+                        Component: ThemeSync
+                    },
+                    {
+                        id: 'users.account',
+                        order: 10,
+                        Component: AccountMenu
+                    }
+                ]
+            }
+        ]
+    };
+}

package/dist/lib/types/member/index.d.ts

@@ -0,0 +1,63 @@
+import type { AvatarColor } from '@ortha-cms/design-system';
+/** The three assignable system roles, by stable key. */
+export type MemberRole = 'admin' | 'contributor' | 'viewer';
+/**
+ * Account lifecycle state, mirroring the server's `user_status` enum.
+ * `pending` renders as the "Invited" pill — an invite that has been sent but
+ * not yet accepted.
+ */
+export type MemberStatus = 'pending' | 'active' | 'disabled';
+/** A workspace a member belongs to, as shown in the Workspaces column. */
+export type MemberWorkspace = {
+    /** Stable workspace id. */
+    id: string;
+    /** Display name. */
+    name: string;
+    /** Short description, or `null` when none is set. */
+    description: string | null;
+    /** Two-letter initials shown in the avatar. */
+    initials: string;
+    /** Accent color tinting the workspace's avatar. */
+    color: AvatarColor;
+};
+/** A member of the system — one row of the Members table. */
+export type Member = {
+    /** Stable user id. */
+    id: string;
+    /** Display name; falls back to the email until the invite is accepted. */
+    name: string;
+    /** Contact email. */
+    email: string;
+    /** Two-letter initials shown in the avatar. */
+    initials: string;
+    /** Accent color tinting the member's avatar (derived, not persisted). */
+    color: AvatarColor;
+    /** The member's single global role, by key. */
+    role: MemberRole;
+    /** Human-readable role label (e.g. `Administrator`). */
+    roleName: string;
+    /** Account lifecycle state. */
+    status: MemberStatus;
+    /** When the membership was created; the invite date while `pending`. */
+    joinedAt: Date;
+    /**
+     * Whether this member is the only active administrator, computed
+     * server-side. When set, demote/disable controls are disabled with an
+     * explanatory tooltip — the server rejects those actions regardless.
+     */
+    isLastAdmin: boolean;
+    /** The workspaces this member belongs to. */
+    workspaces: MemberWorkspace[];
+};
+/** One page of members plus the pagination envelope. */
+export type MemberList = {
+    /** The members on this page. */
+    items: Member[];
+    /** Total members matching the search, across all pages. */
+    total: number;
+    /** 1-based page number. */
+    page: number;
+    /** Rows per page. */
+    pageSize: number;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/types/member/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/member/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE5D,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,aAAa,GAAG,QAAQ,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE7D,0EAA0E;AAC1E,MAAM,MAAM,eAAe,GAAG;IAC1B,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,KAAK,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,MAAM,GAAG;IACjB,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,KAAK,EAAE,WAAW,CAAC;IACnB,+CAA+C;IAC/C,IAAI,EAAE,UAAU,CAAC;IACjB,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,MAAM,EAAE,YAAY,CAAC;IACrB,wEAAwE;IACxE,QAAQ,EAAE,IAAI,CAAC;IACf;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB,6CAA6C;IAC7C,UAAU,EAAE,eAAe,EAAE,CAAC;CACjC,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG;IACrB,gCAAgC;IAChC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/lib/utils/membersFilterFields/index.d.ts

@@ -0,0 +1,10 @@
+import { type FilterField } from '@ortha-cms/query-builder-admin';
+/**
+ * The members filter surface the query builder offers. A static mirror of the
+ * server's `USERS_FILTER_SCHEMA` — each `id` matches a whitelisted field (the
+ * `role.key` dotted path resolves to the BE's `role` relation), so a rule built
+ * here always validates server-side. `status` / `role` render as dropdowns; the
+ * BE still accepts any role key string, the UI just offers the system roles.
+ */
+export declare const MEMBERS_FILTER_FIELDS: readonly FilterField[];
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/membersFilterFields/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/membersFilterFields/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAoC9E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,EAAE,SAAS,WAAW,EAwBvD,CAAC"}

package/dist/lib/utils/membersKeys/index.d.ts

@@ -0,0 +1,27 @@
+/** Parameters accepted by `GET /api/users` — the list query's filter/paging. */
+export type MembersListParams = {
+    /** Case-insensitive name/email substring; omit for no filter. */
+    search?: string;
+    /** Query-builder filter tree as a JSON string; omit for no structured filter. */
+    filter?: string;
+    /** 1-based page number; the server defaults to 1. */
+    page?: number;
+    /** Rows per page; the server defaults to its own page size. */
+    pageSize?: number;
+};
+/**
+ * Query keys for the members cache. The list endpoint lives under
+ * `membersKeys.list(params)`; mutations invalidate `membersKeys.all` to
+ * refresh every cached page (an added/changed/removed row may land anywhere).
+ */
+export declare const membersKeys: {
+    /** Root key covering every members query. */
+    all: readonly ["members"];
+    /** One list page for the given params. */
+    list: (params: MembersListParams) => readonly ["members", "list", MembersListParams];
+    /** One member's full detail record (the user detail page). */
+    detail: (id: string) => readonly ["members", "detail", string];
+    /** One member's live sessions (the detail page's Sessions tab). */
+    sessions: (id: string) => readonly ["members", "detail", string, "sessions"];
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/membersKeys/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/membersKeys/index.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,MAAM,MAAM,iBAAiB,GAAG;IAC5B,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW;IACpB,6CAA6C;;IAE7C,0CAA0C;mBAC3B,iBAAiB;IAChC,8DAA8D;iBACjD,MAAM;IACnB,mEAAmE;mBACpD,MAAM;CACxB,CAAC"}

package/dist/lib/utils/toMember/index.d.ts

@@ -0,0 +1,33 @@
+import type { Member, MemberStatus } from '../../types/member';
+/** A member's role as returned by the API. */
+export type MemberRoleResponse = {
+    id: string;
+    key: string;
+    name: string;
+};
+/** A member's workspace as returned by the API. */
+export type MemberWorkspaceResponse = {
+    id: string;
+    name: string;
+    description: string | null;
+    color: string;
+};
+/**
+ * A member as returned by the users API. `name` is `null` until the invite is
+ * accepted; `createdAt` is an ISO timestamp (the invite date while
+ * `pending`); `isLastAdmin` is the server-computed "sole active admin" flag
+ * the guardrail UI reads.
+ */
+export type MemberResponse = {
+    id: string;
+    email: string;
+    name: string | null;
+    role: MemberRoleResponse;
+    status: MemberStatus;
+    createdAt: string;
+    isLastAdmin: boolean;
+    workspaces: MemberWorkspaceResponse[];
+};
+/** Maps a member from the wire to the admin's `Member` model. */
+export declare function toMember(dto: MemberResponse): Member;
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/toMember/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/toMember/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAc,YAAY,EAAmB,MAAM,oBAAoB,CAAC;AAQ5F,8CAA8C;AAC9C,MAAM,MAAM,kBAAkB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,mDAAmD;AACnD,MAAM,MAAM,uBAAuB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,uBAAuB,EAAE,CAAC;CACzC,CAAC;AAaF,iEAAiE;AACjE,wBAAgB,QAAQ,CAAC,GAAG,EAAE,cAAc,GAAG,MAAM,CAiBpD"}

package/dist/lib/utils/userDetailContext/index.d.ts

@@ -0,0 +1,13 @@
+import type { Member } from '../../types/member';
+/**
+ * Outlet context shared by the user-detail layout with every tab. The layout
+ * fetches the member once and exposes it here, so the tabs read the same
+ * record instead of each issuing its own request.
+ */
+export type UserDetailContext = {
+    /** The member whose detail page is open. */
+    member: Member;
+};
+/** Reads the current member from the user-detail layout's Outlet context. */
+export declare function useUserDetailContext(): UserDetailContext;
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/userDetailContext/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/userDetailContext/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,6EAA6E;AAC7E,wBAAgB,oBAAoB,IAAI,iBAAiB,CAExD"}

package/dist/lib/utils/usersPlugin/index.d.ts

@@ -0,0 +1,27 @@
+import type { AdminPlugin } from '@ortha-cms/bootstrap-admin';
+/**
+ * Admin-side users plugin shape. A thin alias of {@link AdminPlugin}, kept
+ * named so future config (sub-routes, slots) has a home.
+ */
+export type UsersAdminPlugin = AdminPlugin;
+/**
+ * Creates the admin-side users plugin. It owns the members feature: the
+ * private `/users` route (the Members page, rendered inside the shell's
+ * authenticated layout) and its toolbar nav entry, contributed to the shell's
+ * {@link NAVBAR_START_SLOT} at `order: 30` (after Workspaces). The page itself
+ * gates on the `users:read` permission.
+ *
+ * @example
+ * ```typescript
+ * createAdmin({
+ *   plugins: [
+ *     IdentityPlugin(),
+ *     ShellPlugin(),
+ *     WorkspacesPlugin(),
+ *     UsersPlugin(),
+ *   ],
+ * });
+ * ```
+ */
+export declare function UsersPlugin(): UsersAdminPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/usersPlugin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/usersPlugin/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AA+B9D;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAE3C;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,WAAW,IAAI,gBAAgB,CA4D9C"}

package/package.json

@@ -0,0 +1,50 @@
+{
+    "name": "@orthacms/users-admin",
+    "version": "0.0.0-reserve.0",
+    "description": "@orthacms/users-admin — part of Ortha CMS.",
+    "license": "MIT",
+    "homepage": "https://github.com/ortha-source/ortha-cms/tree/main/packages/users/admin",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/ortha-source/ortha-cms.git",
+        "directory": "packages/users/admin"
+    },
+    "bugs": {
+        "url": "https://github.com/ortha-source/ortha-cms/issues"
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist"
+    ],
+    "dependencies": {
+        "@orthacms/activity-admin": "^0.0.1",
+        "@orthacms/bootstrap-admin": "^0.0.1",
+        "@orthacms/design-system": "^0.0.1",
+        "@orthacms/identity-admin": "^0.0.1",
+        "@orthacms/query-builder-admin": "^0.0.1",
+        "@orthacms/shell-admin": "^0.0.1",
+        "@orthacms/utils-admin": "^0.0.1",
+        "@tanstack/react-form": "^1.0.0",
+        "@tanstack/react-query": "^5.0.0",
+        "lucide-react": "^1.17.0",
+        "react-intl": "^7.0.0",
+        "tslib": "^2.3.0",
+        "zod": "^4.4.3"
+    },
+    "peerDependencies": {
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0",
+        "react-router-dom": "^6.0.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}