@byline/ui 0.9.3

package/src/react.ts

@@ -0,0 +1,79 @@
+/**
+ * NOTE: We put a .js ending on imports here to satisfy
+ * TS / dist output
+ */
+
+export * from './admin/components/admin-account/change-password.js'
+export * from './admin/components/admin-account/container.js'
+export * from './admin/components/admin-account/update.js'
+export * from './admin/components/admin-permissions/inspector.js'
+export * from './admin/components/admin-roles/create.js'
+export * from './admin/components/admin-roles/permissions.js'
+export * from './admin/components/admin-roles/update.js'
+export * from './admin/components/admin-users/create.js'
+export * from './admin/components/admin-users/roles.js'
+export * from './admin/components/admin-users/set-password.js'
+export * from './admin/components/admin-users/update.js'
+export * from './admin/components/auth/sign-in-form.js'
+export * from './admin/components/collections/diff-modal.js'
+export * from './admin/components/collections/status-badge.js'
+export * from './admin/group.js'
+export * from './admin/row.js'
+export * from './admin/tabs.js'
+// Used for creating theme test pages in client applications
+export * from './dnd/draggable-sortable/index.js'
+export * from './fields/array/array-field.js'
+export * from './fields/blocks/blocks-field.js'
+export * from './fields/checkbox/checkbox-field.js'
+export * from './fields/column-formatter.js'
+export * from './fields/date-time-formatter.js'
+export * from './fields/datetime/datetime-field.js'
+export * from './fields/draggable-context-menu.js'
+export * from './fields/field-helpers.js'
+export * from './fields/field-renderer.js'
+export * from './fields/file/file-field.js'
+export * from './fields/group/group-field.js'
+export * from './fields/image/image-field.js'
+export * from './fields/image/image-upload-field.js'
+export * from './fields/local-date-time.js'
+export * from './fields/locale-badge.js'
+export * from './fields/numerical/numerical-field.js'
+export * from './fields/relation/relation-field.js'
+export * from './fields/relation/relation-picker.js'
+export * from './fields/select/select-field.js'
+export * from './fields/sortable-item.js'
+export * from './fields/text/text-field.js'
+export * from './fields/text-area/text-area-field.js'
+export * from './fields/use-field-change-handler.js'
+export * from './forms/document-actions.js'
+export * from './forms/form-context.js'
+export * from './forms/form-renderer.js'
+export * from './forms/navigation-guard.js'
+export * from './forms/path-widget.js'
+export * from './services/admin-services-context.js'
+export * from './services/field-services-context.js'
+export type {
+  AdminServiceCall,
+  BylineAdminServices,
+  ChangeAccountPasswordInput,
+  CreateAdminRoleInput,
+  CreateAdminUserInput,
+  SetAdminUserPasswordInput,
+  SetRoleAbilitiesInput,
+  SetUserRolesInput,
+  SignInInput,
+  SignInResult,
+  UpdateAccountInput,
+  UpdateAdminRoleInput,
+  UpdateAdminUserInput,
+  WhoHasAbilityInput,
+} from './services/admin-services-types.js'
+export type {
+  BylineFieldServices,
+  CollectionListDoc,
+  CollectionListParams,
+  CollectionListResponse,
+  GetCollectionDocumentsFn,
+  UploadedFileResult,
+  UploadFieldFn,
+} from './services/field-services-types.js'

package/src/services/admin-services-context.tsx

@@ -0,0 +1,35 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+import { createContext, type ReactNode, useContext } from 'react'
+
+import type { BylineAdminServices } from './admin-services-types.js'
+
+const AdminServicesContext = createContext<BylineAdminServices | null>(null)
+
+interface BylineAdminServicesProviderProps {
+  services: BylineAdminServices
+  children: ReactNode
+}
+
+export const BylineAdminServicesProvider = ({
+  services,
+  children,
+}: BylineAdminServicesProviderProps) => (
+  <AdminServicesContext.Provider value={services}>{children}</AdminServicesContext.Provider>
+)
+
+export const useBylineAdminServices = (): BylineAdminServices => {
+  const ctx = useContext(AdminServicesContext)
+  if (!ctx) {
+    throw new Error(
+      '@byline/ui: BylineAdminServicesProvider missing. Wrap your admin tree with <BylineAdminServicesProvider services={…} />.'
+    )
+  }
+  return ctx
+}

package/src/services/admin-services-types.ts

@@ -0,0 +1,177 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * Framework-neutral function contracts that admin UI components in
+ * `@byline/ui` need from the host application. The host wires concrete
+ * implementations via `BylineAdminServicesProvider` — typically thin
+ * adapters around TanStack Start server functions, Next.js server
+ * actions, or any other RPC-style transport.
+ *
+ * The call shape `(args: { data: TInput }) => Promise<TOutput>` mirrors
+ * TanStack Start's `createServerFn().handler()` calling convention so a
+ * webapp host can pass its server fns through as-is. Other transports
+ * just need a tiny adapter.
+ *
+ * Scope: Phase 2.1 covers the framework-neutral admin UI components
+ * only — the 15 forms, modals, and inner widgets that don't touch
+ * TanStack Router. Page containers (list/edit/delete pages) keep using
+ * server fns directly today and move into `@byline/host-tanstack-start`
+ * in Phase 3 along with the route factories.
+ */
+
+import type {
+  AccountResponse,
+  ChangeAccountPasswordRequest,
+  UpdateAccountRequest,
+} from '@byline/admin/admin-account'
+import type {
+  SetRoleAbilitiesResponse,
+  WhoHasAbilityResponse,
+} from '@byline/admin/admin-permissions'
+import type { AdminRoleResponse, UserRolesResponse } from '@byline/admin/admin-roles'
+import type { AdminUserResponse } from '@byline/admin/admin-users'
+
+/**
+ * The TanStack Start `createServerFn(...).handler(...)` calling shape:
+ * `fn({ data: input }) → Promise<output>`. Hosts using a different
+ * transport supply small adapters that match this shape.
+ */
+export type AdminServiceCall<TInput, TOutput> = (args: { data: TInput }) => Promise<TOutput>
+
+// --- Auth -----------------------------------------------------------------
+
+export interface SignInInput {
+  email: string
+  password: string
+}
+
+/**
+ * The admin UI's sign-in form does not consume the `SignInResult`
+ * payload directly — on success it navigates via `window.location`. The
+ * shape is left as `unknown` here so each host's session provider can
+ * supply whatever envelope it produces without forcing a public type.
+ */
+export type SignInResult = unknown
+
+// --- Account self-service -------------------------------------------------
+
+/** Same shape as `UpdateAccountRequest` from `@byline/admin/admin-account`. */
+export type UpdateAccountInput = UpdateAccountRequest
+
+/** Same shape as `ChangeAccountPasswordRequest` from `@byline/admin/admin-account`. */
+export type ChangeAccountPasswordInput = ChangeAccountPasswordRequest
+
+// --- Admin users ----------------------------------------------------------
+
+export interface CreateAdminUserInput {
+  email: string
+  password: string
+  given_name?: string | null
+  family_name?: string | null
+  username?: string | null
+  is_super_admin: boolean
+  is_enabled: boolean
+  is_email_verified: boolean
+}
+
+export interface UpdateAdminUserInput {
+  id: string
+  vid: number
+  patch: {
+    email?: string
+    given_name?: string | null
+    family_name?: string | null
+    username?: string | null
+    is_super_admin?: boolean
+    is_enabled?: boolean
+    is_email_verified?: boolean
+  }
+}
+
+export interface SetAdminUserPasswordInput {
+  id: string
+  vid: number
+  password: string
+}
+
+export interface SetUserRolesInput {
+  userId: string
+  roleIds: string[]
+}
+
+// --- Admin roles ----------------------------------------------------------
+
+export interface CreateAdminRoleInput {
+  name: string
+  machine_name: string
+  description: string | null
+}
+
+export interface UpdateAdminRoleInput {
+  id: string
+  vid: number
+  patch: {
+    name?: string
+    description?: string | null
+  }
+}
+
+// --- Permissions ----------------------------------------------------------
+
+export interface SetRoleAbilitiesInput {
+  id: string
+  abilities: string[]
+}
+
+export interface WhoHasAbilityInput {
+  ability: string
+}
+
+// --- Service contract -----------------------------------------------------
+
+export interface BylineAdminServices {
+  // Auth
+  adminSignIn: AdminServiceCall<SignInInput, SignInResult>
+
+  // Account self-service
+  updateAccount: AdminServiceCall<UpdateAccountInput, AccountResponse>
+  changeAccountPassword: AdminServiceCall<ChangeAccountPasswordInput, AccountResponse>
+
+  // Admin user writes (page-container reads stay in the host for now)
+  createAdminUser: AdminServiceCall<CreateAdminUserInput, AdminUserResponse>
+  updateAdminUser: AdminServiceCall<UpdateAdminUserInput, AdminUserResponse>
+  setAdminUserPassword: AdminServiceCall<SetAdminUserPasswordInput, AdminUserResponse>
+  setUserRoles: AdminServiceCall<SetUserRolesInput, UserRolesResponse>
+
+  // Admin role writes
+  createAdminRole: AdminServiceCall<CreateAdminRoleInput, AdminRoleResponse>
+  updateAdminRole: AdminServiceCall<UpdateAdminRoleInput, AdminRoleResponse>
+
+  // Permissions
+  setRoleAbilities: AdminServiceCall<SetRoleAbilitiesInput, SetRoleAbilitiesResponse>
+  whoHasAbility: AdminServiceCall<WhoHasAbilityInput, WhoHasAbilityResponse>
+
+  /**
+   * Diff helper. Loads a specific historical version of a document so
+   * the diff modal can compare it against the current version. Returns
+   * the same shape as the regular document loader — the diff modal
+   * consumes only `doc.fields` (or strips known meta keys when an
+   * older flat-shape doc is encountered).
+   *
+   * Positional-args shape rather than `{ data }` because this helper
+   * predates the contract and is consumed only by `DiffModal`. Hosts
+   * adapt their server fn into this call signature.
+   */
+  getCollectionDocumentVersion: (
+    collection: string,
+    documentId: string,
+    versionId: string,
+    locale: string | undefined
+  ) => Promise<Record<string, unknown>>
+}

package/src/services/field-services-context.tsx

@@ -0,0 +1,35 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+import { createContext, type ReactNode, useContext } from 'react'
+
+import type { BylineFieldServices } from './field-services-types'
+
+const FieldServicesContext = createContext<BylineFieldServices | null>(null)
+
+interface BylineFieldServicesProviderProps {
+  services: BylineFieldServices
+  children: ReactNode
+}
+
+export const BylineFieldServicesProvider = ({
+  services,
+  children,
+}: BylineFieldServicesProviderProps) => (
+  <FieldServicesContext.Provider value={services}>{children}</FieldServicesContext.Provider>
+)
+
+export const useBylineFieldServices = (): BylineFieldServices => {
+  const ctx = useContext(FieldServicesContext)
+  if (!ctx) {
+    throw new Error(
+      '@byline/ui: BylineFieldServicesProvider missing. Wrap your admin tree with <BylineFieldServicesProvider services={…} />.'
+    )
+  }
+  return ctx
+}

package/src/services/field-services-types.ts

@@ -0,0 +1,68 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * Framework-neutral function contracts that field/form components in
+ * `@byline/ui` need from the host application. The host wires concrete
+ * implementations via `BylineFieldServicesProvider` — typically thin
+ * adapters around TanStack Start server functions, Next.js server
+ * actions, or any other RPC-style transport.
+ */
+
+import type { StoredFileValue } from '@byline/core'
+
+export interface CollectionListParams {
+  page?: number
+  page_size?: number
+  order?: string
+  desc?: boolean
+  query?: string
+  locale?: string
+  status?: string
+  fields?: string[]
+}
+
+export interface CollectionListDoc {
+  id: string
+  path?: string
+  [field: string]: unknown
+}
+
+export interface CollectionListResponse {
+  docs: CollectionListDoc[]
+  meta: { totalPages?: number; [k: string]: unknown }
+  included: { collection: { id: string; [k: string]: unknown } }
+}
+
+export type GetCollectionDocumentsFn = (input: {
+  collection: string
+  params: CollectionListParams
+}) => Promise<CollectionListResponse>
+
+export interface UploadedFileResult {
+  documentId?: string
+  documentVersionId?: string
+  /**
+   * The persisted file value, including the `variants` array with
+   * `storagePath`, `storageUrl`, `width`, `height`, and `format` for each
+   * generated derivative. Single source of truth — the legacy top-level
+   * `variants: { name, url }[]` is gone.
+   */
+  storedFile: StoredFileValue
+}
+
+export type UploadFieldFn = (
+  collection: string,
+  formData: FormData,
+  createDocument?: boolean
+) => Promise<UploadedFileResult>
+
+export interface BylineFieldServices {
+  getCollectionDocuments: GetCollectionDocumentsFn
+  uploadField: UploadFieldFn
+}