@karni/ui 0.0.0-stage → 0.4.0

package/dist/manifest.json

@@ -0,0 +1,102 @@
+{
+  "components": [
+    "AuthGuard",
+    "AuthProvider",
+    "Button",
+    "ChangeHistory",
+    "Checkbox",
+    "DataChart",
+    "DropdownMenu",
+    "DropdownMenuCheckboxItem",
+    "DropdownMenuContent",
+    "DropdownMenuGroup",
+    "DropdownMenuItem",
+    "DropdownMenuLabel",
+    "DropdownMenuPortal",
+    "DropdownMenuSeparator",
+    "DropdownMenuTrigger",
+    "EmptyState",
+    "EmptyValue",
+    "ErrorState",
+    "FileUpload",
+    "Input",
+    "KarniMark",
+    "KarniPrimitivesProvider",
+    "KarniProvider",
+    "Label",
+    "Layout",
+    "LoginForm",
+    "Modal",
+    "ModalClose",
+    "ModalDescription",
+    "ModalTitle",
+    "Page",
+    "PendingButton",
+    "PermissionDenied",
+    "ResourceDetail",
+    "ResourceForm",
+    "ResourceImport",
+    "ResourceSelect",
+    "ResourceTable",
+    "Select",
+    "SelectContent",
+    "SelectGroup",
+    "SelectItem",
+    "SelectLabel",
+    "SelectRoot",
+    "SelectSeparator",
+    "SelectTrigger",
+    "SelectValue",
+    "Skeleton",
+    "Stat",
+    "Switch",
+    "Tabs",
+    "TabsContent",
+    "TabsList",
+    "TabsTrigger",
+    "Textarea",
+    "ThemeProvider",
+    "ThemeToggle",
+    "Toaster"
+  ],
+  "hooks": [
+    "useAuth",
+    "useChangeHistory",
+    "useDelayedFlag",
+    "useImportActions",
+    "useImportDescribe",
+    "useImportJob",
+    "useKarniClient",
+    "useKarniPrimitives",
+    "useOnlineStatus",
+    "usePermission",
+    "useResourceItem",
+    "useResourceList",
+    "useResourceMutations",
+    "useSchema",
+    "useTheme",
+    "useToast",
+    "useUnsavedChangesGuard"
+  ],
+  "roles": {
+    "async-select": "ResourceSelect",
+    "auth-guard": "AuthGuard",
+    "change-history": "ChangeHistory",
+    "chart": "DataChart",
+    "data-table": "ResourceTable",
+    "detail-view": "ResourceDetail",
+    "empty-state": "EmptyState",
+    "error-state": "ErrorState",
+    "file-upload": "FileUpload",
+    "layout-shell": "Layout",
+    "login-form": "LoginForm",
+    "modal": "Modal",
+    "page-shell": "Page",
+    "permission-denied": "PermissionDenied",
+    "resource-form": "ResourceForm",
+    "resource-import": "ResourceImport",
+    "stat": "Stat",
+    "theme-toggle": "ThemeToggle",
+    "toast": "Toaster"
+  }
+}

package/dist/mockServiceWorker.js

@@ -0,0 +1,361 @@
+/* eslint-disable */
+/* tslint:disable */
+
+/**
+ * Mock Service Worker.
+ * @see https://github.com/mswjs/msw
+ * - Please do NOT modify this file.
+ */
+
+const PACKAGE_VERSION = '2.15.0'
+const INTEGRITY_CHECKSUM = '03cb67ac84128e63d7cd722a6e5b7f1e'
+const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
+const activeClientIds = new Set()
+
+addEventListener('install', function () {
+  self.skipWaiting()
+})
+
+addEventListener('activate', function (event) {
+  event.waitUntil(self.clients.claim())
+})
+
+addEventListener('message', async function (event) {
+  const clientId = Reflect.get(event.source || {}, 'id')
+
+  if (!clientId || !self.clients) {
+    return
+  }
+
+  const client = await self.clients.get(clientId)
+
+  if (!client) {
+    return
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  switch (event.data) {
+    case 'KEEPALIVE_REQUEST': {
+      sendToClient(client, {
+        type: 'KEEPALIVE_RESPONSE',
+      })
+      break
+    }
+
+    case 'INTEGRITY_CHECK_REQUEST': {
+      sendToClient(client, {
+        type: 'INTEGRITY_CHECK_RESPONSE',
+        payload: {
+          packageVersion: PACKAGE_VERSION,
+          checksum: INTEGRITY_CHECKSUM,
+        },
+      })
+      break
+    }
+
+    case 'MOCK_ACTIVATE': {
+      activeClientIds.add(clientId)
+
+      sendToClient(client, {
+        type: 'MOCKING_ENABLED',
+        payload: {
+          client: {
+            id: client.id,
+            frameType: client.frameType,
+          },
+        },
+      })
+      break
+    }
+
+    case 'CLIENT_CLOSED': {
+      activeClientIds.delete(clientId)
+
+      const remainingClients = allClients.filter((client) => {
+        return client.id !== clientId
+      })
+
+      // Unregister itself when there are no more clients
+      if (remainingClients.length === 0) {
+        self.registration.unregister()
+      }
+
+      break
+    }
+  }
+})
+
+addEventListener('fetch', function (event) {
+  const requestInterceptedAt = Date.now()
+
+  // Bypass navigation requests.
+  if (event.request.mode === 'navigate') {
+    return
+  }
+
+  // Opening the DevTools triggers the "only-if-cached" request
+  // that cannot be handled by the worker. Bypass such requests.
+  if (
+    event.request.cache === 'only-if-cached' &&
+    event.request.mode !== 'same-origin'
+  ) {
+    return
+  }
+
+  // Bypass all requests when there are no active clients.
+  // Prevents the self-unregistered worked from handling requests
+  // after it's been terminated (still remains active until the next reload).
+  if (activeClientIds.size === 0) {
+    return
+  }
+
+  const requestId = crypto.randomUUID()
+  event.respondWith(handleRequest(event, requestId, requestInterceptedAt))
+})
+
+/**
+ * @param {FetchEvent} event
+ * @param {string} requestId
+ * @param {number} requestInterceptedAt
+ */
+async function handleRequest(event, requestId, requestInterceptedAt) {
+  const client = await resolveMainClient(event)
+  const requestCloneForEvents = event.request.clone()
+  const response = await getResponse(
+    event,
+    client,
+    requestId,
+    requestInterceptedAt,
+  )
+
+  // Send back the response clone for the "response:*" life-cycle events.
+  // Ensure MSW is active and ready to handle the message, otherwise
+  // this message will pend indefinitely.
+  if (client && activeClientIds.has(client.id)) {
+    const serializedRequest = await serializeRequest(requestCloneForEvents)
+
+    // Omit the body of server-sent event stream responses.
+    // Cloning such responses would prevent client-side stream cancelations
+    // from reaching the original stream (a teed stream only cancels its
+    // source once both of its branches cancel) and would buffer the
+    // entire stream into the unconsumed clone indefinitely.
+    const isEventStreamResponse = response.headers
+      .get('content-type')
+      ?.toLowerCase()
+      .startsWith('text/event-stream')
+
+    // Clone the response so both the client and the library could consume it.
+    const responseClone = isEventStreamResponse ? null : response.clone()
+
+    sendToClient(
+      client,
+      {
+        type: 'RESPONSE',
+        payload: {
+          isMockedResponse: IS_MOCKED_RESPONSE in response,
+          request: {
+            id: requestId,
+            ...serializedRequest,
+          },
+          response: {
+            type: response.type,
+            status: response.status,
+            statusText: response.statusText,
+            headers: Object.fromEntries(response.headers.entries()),
+            body: responseClone ? responseClone.body : null,
+          },
+        },
+      },
+      responseClone && responseClone.body
+        ? [serializedRequest.body, responseClone.body]
+        : [],
+    )
+  }
+
+  return response
+}
+
+/**
+ * Resolve the main client for the given event.
+ * Client that issues a request doesn't necessarily equal the client
+ * that registered the worker. It's with the latter the worker should
+ * communicate with during the response resolving phase.
+ * @param {FetchEvent} event
+ * @returns {Promise<Client | undefined>}
+ */
+async function resolveMainClient(event) {
+  const client = await self.clients.get(event.clientId)
+
+  if (activeClientIds.has(event.clientId)) {
+    return client
+  }
+
+  if (client?.frameType === 'top-level') {
+    return client
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  return allClients
+    .filter((client) => {
+      // Get only those clients that are currently visible.
+      return client.visibilityState === 'visible'
+    })
+    .find((client) => {
+      // Find the client ID that's recorded in the
+      // set of clients that have registered the worker.
+      return activeClientIds.has(client.id)
+    })
+}
+
+/**
+ * @param {FetchEvent} event
+ * @param {Client | undefined} client
+ * @param {string} requestId
+ * @param {number} requestInterceptedAt
+ * @returns {Promise<Response>}
+ */
+async function getResponse(event, client, requestId, requestInterceptedAt) {
+  // Clone the request because it might've been already used
+  // (i.e. its body has been read and sent to the client).
+  const requestClone = event.request.clone()
+
+  function passthrough() {
+    // Cast the request headers to a new Headers instance
+    // so the headers can be manipulated with.
+    const headers = new Headers(requestClone.headers)
+
+    // Remove the "accept" header value that marked this request as passthrough.
+    // This prevents request alteration and also keeps it compliant with the
+    // user-defined CORS policies.
+    const acceptHeader = headers.get('accept')
+    if (acceptHeader) {
+      const values = acceptHeader.split(',').map((value) => value.trim())
+      const filteredValues = values.filter(
+        (value) => value !== 'msw/passthrough',
+      )
+
+      if (filteredValues.length > 0) {
+        headers.set('accept', filteredValues.join(', '))
+      } else {
+        headers.delete('accept')
+      }
+    }
+
+    return fetch(requestClone, { headers })
+  }
+
+  // Bypass mocking when the client is not active.
+  if (!client) {
+    return passthrough()
+  }
+
+  // Bypass initial page load requests (i.e. static assets).
+  // The absence of the immediate/parent client in the map of the active clients
+  // means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
+  // and is not ready to handle requests.
+  if (!activeClientIds.has(client.id)) {
+    return passthrough()
+  }
+
+  // Notify the client that a request has been intercepted.
+  const serializedRequest = await serializeRequest(event.request)
+  const clientMessage = await sendToClient(
+    client,
+    {
+      type: 'REQUEST',
+      payload: {
+        id: requestId,
+        interceptedAt: requestInterceptedAt,
+        ...serializedRequest,
+      },
+    },
+    [serializedRequest.body],
+  )
+
+  switch (clientMessage.type) {
+    case 'MOCK_RESPONSE': {
+      return respondWithMock(clientMessage.data)
+    }
+
+    case 'PASSTHROUGH': {
+      return passthrough()
+    }
+  }
+
+  return passthrough()
+}
+
+/**
+ * @param {Client} client
+ * @param {any} message
+ * @param {Array<Transferable>} transferrables
+ * @returns {Promise<any>}
+ */
+function sendToClient(client, message, transferrables = []) {
+  return new Promise((resolve, reject) => {
+    const channel = new MessageChannel()
+
+    channel.port1.onmessage = (event) => {
+      if (event.data && event.data.error) {
+        return reject(event.data.error)
+      }
+
+      resolve(event.data)
+    }
+
+    client.postMessage(message, [
+      channel.port2,
+      ...transferrables.filter(Boolean),
+    ])
+  })
+}
+
+/**
+ * @param {Response} response
+ * @returns {Response}
+ */
+function respondWithMock(response) {
+  // Setting response status code to 0 is a no-op.
+  // However, when responding with a "Response.error()", the produced Response
+  // instance will have status code set to 0. Since it's not possible to create
+  // a Response instance with status code 0, handle that use-case separately.
+  if (response.status === 0) {
+    return Response.error()
+  }
+
+  const mockedResponse = new Response(response.body, response)
+
+  Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, {
+    value: true,
+    enumerable: true,
+  })
+
+  return mockedResponse
+}
+
+/**
+ * @param {Request} request
+ */
+async function serializeRequest(request) {
+  return {
+    url: request.url,
+    mode: request.mode,
+    method: request.method,
+    headers: Object.fromEntries(request.headers.entries()),
+    cache: request.cache,
+    credentials: request.credentials,
+    destination: request.destination,
+    integrity: request.integrity,
+    redirect: request.redirect,
+    referrer: request.referrer,
+    referrerPolicy: request.referrerPolicy,
+    body: await request.arrayBuffer(),
+    keepalive: request.keepalive,
+  }
+}

package/dist/script-BVJ9BbPm.cjs

@@ -0,0 +1,2 @@
+var e=`karni-theme`,t=`(function(){try{var t=localStorage.getItem("${e}");var d=t==="dark"||((t===null||t==="system")&&matchMedia("(prefers-color-scheme: dark)").matches);document.documentElement.classList.toggle("dark",d);document.documentElement.style.colorScheme=d?"dark":"light"}catch(e){}})();`;Object.defineProperty(exports,"n",{enumerable:!0,get:function(){return e}}),Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return t}});
+//# sourceMappingURL=script-BVJ9BbPm.cjs.map

package/dist/script-BVJ9BbPm.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"script-BVJ9BbPm.cjs","names":["THEME_STORAGE_KEY","KARNI_THEME_SCRIPT"],"sources":["../src/theme/script.ts"],"sourcesContent":["/**\n * The theme's pre-paint script, with no React: shared by ThemeProvider and\n * the `@karni/ui/vite` plugin, which runs in Node at build time.\n */\n\n/** The localStorage key ThemeProvider keeps the user's choice under. */\nexport const THEME_STORAGE_KEY = \"karni-theme\";\n\n/**\n * Inline script for index.html's `<head>`: applies the stored (or system) theme\n * before the first paint. Uses the default storage key. In a Vite app,\n * `karniTheme()` from `@karni/ui/vite` puts it there.\n */\nexport const KARNI_THEME_SCRIPT = `(function(){try{var t=localStorage.getItem(\"${THEME_STORAGE_KEY}\");var d=t===\"dark\"||((t===null||t===\"system\")&&matchMedia(\"(prefers-color-scheme: dark)\").matches);document.documentElement.classList.toggle(\"dark\",d);document.documentElement.style.colorScheme=d?\"dark\":\"light\"}catch(e){}})();`;\n"],"mappings":"AAMA,IAAaA,EAAoB,cAOpBC,EAAqB,+CAA+CD,EAAkB,qO"}

package/dist/script-D1fn4Dm4.js

@@ -0,0 +1,6 @@
+//#region src/theme/script.ts
+var e = "karni-theme", t = `(function(){try{var t=localStorage.getItem("${e}");var d=t==="dark"||((t===null||t==="system")&&matchMedia("(prefers-color-scheme: dark)").matches);document.documentElement.classList.toggle("dark",d);document.documentElement.style.colorScheme=d?"dark":"light"}catch(e){}})();`;
+//#endregion
+export { e as n, t };
+
+//# sourceMappingURL=script-D1fn4Dm4.js.map

package/dist/script-D1fn4Dm4.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"script-D1fn4Dm4.js","names":["THEME_STORAGE_KEY","KARNI_THEME_SCRIPT"],"sources":["../src/theme/script.ts"],"sourcesContent":["/**\n * The theme's pre-paint script, with no React: shared by ThemeProvider and\n * the `@karni/ui/vite` plugin, which runs in Node at build time.\n */\n\n/** The localStorage key ThemeProvider keeps the user's choice under. */\nexport const THEME_STORAGE_KEY = \"karni-theme\";\n\n/**\n * Inline script for index.html's `<head>`: applies the stored (or system) theme\n * before the first paint. Uses the default storage key. In a Vite app,\n * `karniTheme()` from `@karni/ui/vite` puts it there.\n */\nexport const KARNI_THEME_SCRIPT = `(function(){try{var t=localStorage.getItem(\"${THEME_STORAGE_KEY}\");var d=t===\"dark\"||((t===null||t===\"system\")&&matchMedia(\"(prefers-color-scheme: dark)\").matches);document.documentElement.classList.toggle(\"dark\",d);document.documentElement.style.colorScheme=d?\"dark\":\"light\"}catch(e){}})();`;\n"],"mappings":";AAMA,IAAaA,IAAoB,eAOpBC,IAAqB,+CAA+CD,EAAkB"}

package/dist/src/auth/AuthGuard.d.ts

@@ -0,0 +1,77 @@
+import { ReactElement, ReactNode } from 'react';
+import { KarniUser } from './types';
+/**
+ * <AuthGuard> renders children only for authenticated users (optionally
+ * holding one of the given roles). Otherwise it renders a fallback or says
+ * why, in plain words (contract "Hooks + auth").
+ *
+ * Two different refusals: with `explain`, a visitor who is not signed in sees
+ * a sign-in prompt (the `Anonymous` slot: a LoginForm, so signing in reveals
+ * the content in place) and a signed-in user whose role lacks access sees
+ * PermissionDenied (the `Denied` slot). `anonymous` / `denied` render your own
+ * node for one of them, and `fallback` (one node for both) keeps working.
+ *
+ * Deprecation (0.4 → 1.0): a guard with none of `explain`, `fallback`,
+ * `anonymous`, `denied` or `slots` renders nothing when it refuses, as in
+ * 0.3, and warns once in development. 1.0 makes `explain` the default. A
+ * guard that hides a piece of UI passes `fallback={null}`.
+ *
+ * While the initial auth state resolves, the `loading` slot renders
+ * (default: nothing) so protected content never flashes a login screen
+ * during session restore.
+ */
+import * as React from "react";
+/** What the `Anonymous` slot receives: nobody is signed in. */
+export interface AuthGuardAnonymousProps {
+    /** The roles the content needs, when the guard names some. */
+    roles: readonly string[];
+    className?: string;
+}
+/** What the `Denied` slot receives: someone is signed in, and no role of theirs is in `roles`. */
+export interface AuthGuardDeniedProps {
+    user: KarniUser;
+    /** The roles the content needs. */
+    roles: readonly string[];
+    className?: string;
+}
+/**
+ * The replaceable refusals of AuthGuard. Pass any subset as `slots`.
+ * `defaultAuthGuardSlots` holds Karni's own, to wrap them.
+ */
+export interface AuthGuardSlots {
+    /** Not signed in: a sign-in prompt. */
+    Anonymous: React.ComponentType<AuthGuardAnonymousProps>;
+    /** Signed in without the role: PermissionDenied. */
+    Denied: React.ComponentType<AuthGuardDeniedProps>;
+}
+export interface AuthGuardProps {
+    /** Grant access when the user holds AT LEAST ONE of these role names. */
+    roles?: string[];
+    /**
+     * Rendered for anonymous users and role mismatches alike. `anonymous` and
+     * `denied` (or `slots`) are preferred: they say which of the two it is.
+     * `null` renders nothing.
+     */
+    fallback?: ReactNode;
+    /** Rendered for a visitor who is not signed in (wins over `fallback`). */
+    anonymous?: ReactNode;
+    /** Rendered for a signed-in user whose role lacks access (wins over `fallback`). */
+    denied?: ReactNode;
+    /** Rendered while the auth status is still "loading". Default: nothing. */
+    loading?: ReactNode;
+    /** Replace the default refusals: Anonymous (sign-in prompt), Denied (PermissionDenied). */
+    slots?: Partial<AuthGuardSlots>;
+    /**
+     * Say why instead of rendering nothing: the sign-in prompt for a visitor,
+     * PermissionDenied for a role mismatch. It is the default from 1.0. Until
+     * then a guard with no fallback and no `explain` renders nothing (and warns).
+     */
+    explain?: boolean;
+    /** Merged onto the default refusal's root. */
+    className?: string;
+    children?: ReactNode;
+}
+/** Karni's own slots, exported so a project can wrap one instead of rewriting it. */
+export declare const defaultAuthGuardSlots: AuthGuardSlots;
+/** Renders its children only for a signed-in user, optionally with one of the given roles, and otherwise says why. */
+export declare function AuthGuard(props: AuthGuardProps): ReactElement | null;

package/dist/src/auth/LoginForm.d.ts

@@ -0,0 +1,63 @@
+import { KarniErrorDescription } from '../states/describe-error';
+import { ErrorSlotProps } from '../states/ErrorState';
+import { KarniUser } from './types';
+/**
+ * LoginForm is the sign-in form every app needs (contract: auth).
+ *
+ * Email + password against `useAuth().login`, with the error inline. On
+ * success it calls `onSuccess(user)` (navigate there). When the backend's
+ * 2FA gate fires, `on2FA` receives the ephemeral token so the app can render
+ * its code step (`POST <authBasePath>/2fa/login/`). Without a handler the
+ * form explains that a code is required. Render it inside `AuthProvider`,
+ * e.g. as `AuthGuard`'s `fallback`.
+ */
+import * as React from "react";
+/** What the `Error` slot receives: ErrorSlotProps plus the message, already worded for sign-in. */
+export interface LoginFormErrorProps extends ErrorSlotProps {
+    /** Put this id on the message's root: the inputs' `aria-describedby` points at it. */
+    id: string;
+    /**
+     * The failure in plain words: wrong credentials ("That email and password
+     * do not match"), throttling ("Wait 42 seconds"), offline, a server error.
+     */
+    described: KarniErrorDescription;
+}
+/**
+ * The replaceable parts of LoginForm. Pass any subset as `slots`.
+ * `defaultLoginFormSlots` holds Karni's own, to wrap them.
+ */
+export interface LoginFormSlots {
+    /** The message under the fields when signing in fails (announced as an alert). */
+    Error: React.ComponentType<LoginFormErrorProps>;
+}
+export interface LoginFormProps {
+    /** Called with the signed-in user. Navigate from here. */
+    onSuccess?: (user: KarniUser) => void;
+    /** Called when the account needs a second factor (the token completes it). */
+    on2FA?: (ephemeralToken: string) => void;
+    /** Heading above the fields. `null` renders none. Default "Sign in". */
+    title?: React.ReactNode;
+    /** Text under the heading (demo logins, a signup link, ...). */
+    description?: React.ReactNode;
+    /** The submit button's label. Default "Sign in". */
+    submitLabel?: React.ReactNode;
+    /** Disables the form (e.g. while the auth status is still "loading"). */
+    disabled?: boolean;
+    /** Focus the email field when the form appears. Default true: signing in is the page's purpose. */
+    autoFocus?: boolean;
+    /** Replace parts of the form: Error. */
+    slots?: Partial<LoginFormSlots>;
+    className?: string;
+}
+/** Karni's own slots, exported so a project can wrap one instead of rewriting it. */
+export declare const defaultLoginFormSlots: LoginFormSlots;
+/**
+ * Email and password sign-in form with inline errors and a callback for the two-factor step.
+ *
+ * Wrong credentials, throttling, a dropped connection and a server error each
+ * read differently. The message is announced, both fields point at it
+ * (`aria-describedby`) and are marked invalid when they are the problem.
+ * After a failure the email stays. Wrong credentials clear the password and
+ * focus it. Escape hatch: `slots.Error`.
+ */
+export declare function LoginForm({ onSuccess, on2FA, title, description, submitLabel, disabled, autoFocus, slots, className, }: LoginFormProps): React.JSX.Element;