@foir/sdk 0.28.0 → 0.30.0

package/dist/media/ProgressiveMedia.d.ts

@@ -1,3 +1,4 @@
+import type { Ref } from 'react';
 import type { ProgressiveImageSource, ProgressiveVideoSource, VariantTierKey } from './media';
 export interface ProgressiveMediaProps {
     image?: ProgressiveImageSource;
@@ -25,6 +26,31 @@ export interface ProgressiveMediaProps {
     muted?: boolean;
     /** Video playback — loop on end. Default true. */
     loop?: boolean;
+    /**
+     * Video playback: show the browser's controls. Defaults to `!autoplay`. A
+     * video with controls shows from the start, its poster standing until it
+     * plays, so the controls can always be reached.
+     */
+    controls?: boolean;
+    /** Video: how much the browser fetches before it plays (`<video preload>`). */
+    preload?: 'none' | 'metadata' | 'auto';
+    /**
+     * Where the media sits in its box when it is cropped to fit, as CSS
+     * `object-position` (`'30% 60%'`), for a focal point. Applies to the image,
+     * the video and its thumbnail. Default centre.
+     */
+    objectPosition?: string;
+    /**
+     * The `<video>` element, once it mounts: for a caller's own play and pause
+     * controls, and the events that keep them in step.
+     */
+    videoRef?: Ref<HTMLVideoElement>;
+    /**
+     * Called once when a video's source cannot be played. The video is then
+     * removed, and its thumbnail, labelled with `alt`, stands in for it over
+     * the colour and blurhash layers.
+     */
+    onVideoError?: () => void;
     /**
      * When false, skip loading the full media layer (no `<video>`/full `<img>`
      * mount, no HLS attach, no full-image preload). The lower layers — colour,
@@ -53,4 +79,4 @@ export interface ProgressiveMediaProps {
      */
     variantTiers?: readonly VariantTierKey[];
 }
-export declare function ProgressiveMedia({ image, video, alt, className, fill, fit, placeholder, autoplay, muted, loop, active, sizes, priority, variantTiers, }: ProgressiveMediaProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function ProgressiveMedia({ image, video, alt, className, fill, fit, placeholder, autoplay, muted, loop, controls, preload, objectPosition, videoRef: externalVideoRef, onVideoError, active, sizes, priority, variantTiers, }: ProgressiveMediaProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/media.js

@@ -213,6 +213,11 @@ function ProgressiveMedia({
   autoplay = true,
   muted = true,
   loop = true,
+  controls,
+  preload,
+  objectPosition,
+  videoRef: externalVideoRef,
+  onVideoError,
   active = true,
   sizes = "100vw",
   priority = false,
@@ -225,7 +230,13 @@ function ProgressiveMedia({
   const source = video ?? image;
   const isVideo = !!video;
   const [wrapperRef, inViewport] = useInViewport("300px", priority);
-  const videoActive = isVideo && active && (priority || inViewport);
+  const [failedUrl, setFailedUrl] = useState2(void 0);
+  const videoFailed = isVideo && failedUrl !== void 0 && failedUrl === video?.url;
+  const [videoSize, setVideoSize] = useState2(
+    null
+  );
+  const videoActive = isVideo && active && !videoFailed && (priority || inViewport);
+  const showControls = controls ?? !autoplay;
   const imageActive = !isVideo && active;
   const hlsUrl = video?.hlsUrl;
   const useHls = isVideo && !!hlsUrl;
@@ -282,6 +293,8 @@ function ProgressiveMedia({
         cleanupRef.current = null;
       }
       videoRef.current = el;
+      if (typeof externalVideoRef === "function") externalVideoRef(el);
+      else if (externalVideoRef) externalVideoRef.current = el;
       if (!el) return;
       if (el.readyState >= 3) {
         onFullReady();
@@ -299,7 +312,7 @@ function ProgressiveMedia({
         el.removeEventListener("playing", handler);
       };
     },
-    [onFullReady]
+    [onFullReady, externalVideoRef]
   );
   if (!source) {
     if (!placeholder) return null;
@@ -314,8 +327,9 @@ function ProgressiveMedia({
     );
   }
   const effective = !isVideo ? effectiveImageDimensions(image) : null;
-  const w = effective?.width ?? source.width;
-  const h = effective?.height ?? source.height;
+  const w = effective?.width ?? source.width ?? videoSize?.w;
+  const h = effective?.height ?? source.height ?? videoSize?.h;
+  const positioned = objectPosition ? { objectPosition } : void 0;
   const aspect = w && h ? w / h : 16 / 10;
   return /* @__PURE__ */ jsxs(
     "div",
@@ -342,13 +356,14 @@ function ProgressiveMedia({
           "img",
           {
             src: thumbnailUrl,
-            alt: "",
-            "aria-hidden": true,
+            alt: videoFailed ? alt ?? "" : "",
+            "aria-hidden": videoFailed ? void 0 : true,
             width: w,
             height: h,
             loading: priority ? "eager" : "lazy",
             fetchPriority: priority ? "high" : void 0,
-            className: `absolute inset-0 h-full w-full ${fitClass} transition-opacity duration-400 ease-in-out ${stage === "thumbnail" || stage === "full" ? "opacity-100" : "opacity-0"}`
+            className: `absolute inset-0 h-full w-full ${fitClass} transition-opacity duration-400 ease-in-out ${stage === "thumbnail" || stage === "full" ? "opacity-100" : "opacity-0"}`,
+            style: positioned
           }
         ),
         videoActive ? /* @__PURE__ */ jsx2(
@@ -363,8 +378,21 @@ function ProgressiveMedia({
             muted,
             loop,
             playsInline: true,
-            controls: !autoplay,
-            className: `absolute inset-0 h-full w-full ${fitClass} transition-opacity duration-500 ease-in-out ${stage === "full" ? "opacity-100" : "opacity-0"}`
+            controls: showControls,
+            preload,
+            "aria-label": alt || void 0,
+            onLoadedMetadata: (e) => {
+              const v = e.currentTarget;
+              if (!source.width && v.videoWidth && v.videoHeight) {
+                setVideoSize({ w: v.videoWidth, h: v.videoHeight });
+              }
+            },
+            onError: () => {
+              setFailedUrl(video?.url);
+              onVideoError?.();
+            },
+            className: `absolute inset-0 h-full w-full ${fitClass} transition-opacity duration-500 ease-in-out ${stage === "full" || showControls ? "opacity-100" : "opacity-0"}`,
+            style: positioned
           }
         ) : imageActive ? (
           // <picture>: browser picks AVIF when it can decode it, else WebP. The
@@ -383,7 +411,8 @@ function ProgressiveMedia({
                 height: h,
                 loading: priority ? "eager" : "lazy",
                 fetchPriority: priority ? "high" : void 0,
-                className: `absolute inset-0 h-full w-full ${fitClass} transition-opacity duration-500 ease-in-out ${stage === "full" ? "opacity-100" : "opacity-0"}`
+                className: `absolute inset-0 h-full w-full ${fitClass} transition-opacity duration-500 ease-in-out ${stage === "full" ? "opacity-100" : "opacity-0"}`,
+                style: positioned
               }
             )
           ] })

package/dist/next/session.d.ts

@@ -27,8 +27,12 @@ interface PasswordArgs {
 }
 /** Password sign-in in a route handler; persists the session to cookies. */
 export declare function foirSignInWithPassword({ env, store, email, password, cookieOptions, }: PasswordArgs): Promise<FoirUser>;
-/** Register a user in a route handler; persists the session to cookies. */
-export declare function foirRegisterWithPassword({ env, store, email, password, cookieOptions, }: PasswordArgs): Promise<FoirUser>;
+/**
+ * Start a sign-up in a route handler: the address is mailed a code, and
+ * {@link foirSignInWithOtp} with it finishes the account and persists the
+ * session to cookies.
+ */
+export declare function foirRegisterWithPassword({ env, email, password, }: Pick<PasswordArgs, 'env' | 'email' | 'password'>): Promise<void>;
 /** Complete an OTP sign-in in a route handler; persists the session to cookies. */
 export declare function foirSignInWithOtp({ env, store, email, otp, cookieOptions, }: {
     env: FoirEnv;

package/dist/next.js

@@ -1127,8 +1127,8 @@ async function getSessionUser(adapter) {
 async function signInWithPassword(adapter, env, vars) {
   return saveSession(adapter, await login(env, vars));
 }
-async function signUpWithPassword(adapter, env, vars) {
-  return saveSession(adapter, await register(env, vars));
+async function signUpWithPassword(env, vars) {
+  await register(env, vars);
 }
 async function signInWithOTP(adapter, env, vars) {
   return saveSession(adapter, await loginWithOTP(env, vars));
@@ -1158,15 +1158,10 @@ function foirSignInWithPassword({
 }
 function foirRegisterWithPassword({
   env,
-  store,
   email,
-  password,
-  cookieOptions
+  password
 }) {
-  return signUpWithPassword(createFoirCookieAdapter(store, { cookieOptions }), env, {
-    email,
-    password
-  });
+  return signUpWithPassword(env, { email, password });
 }
 function foirSignInWithOtp({
   env,

package/dist/placement.js

@@ -32,6 +32,12 @@ var GRANT_TABLE = [
   ["operations:write", "none", [], []],
   ["operations:complete", "none", [], []],
   ["status:write", "none", [], []],
+  ["agents:read", "none", [], []],
+  ["agents:execute", "agent", [], []],
+  ["agents:write", "none", [], []],
+  ["agenttools:execute", "agent_tool", [], []],
+  ["brief:read", "none", [], []],
+  ["brief:write", "none", [], []],
   ["appconfig:read", "none", [], []],
   ["schedules:read", "none", [], []],
   ["schedules:write", "none", [], []],
@@ -70,6 +76,7 @@ var GRANT_TABLE = [
   ["apikeys:write", "none", [], []],
   ["organizations:read", "none", [], []],
   ["organizations:write", "none", [], []],
+  ["orgsettings:write", "none", [], []],
   ["organizations:create", "none", [], []],
   ["organizations:delete", "none", [], []],
   ["organizations:reach", "none", [], []],
@@ -80,7 +87,7 @@ var GRANT_TABLE = [
   ["projects:read", "none", [], []],
   ["projects:write", "none", [], []],
   ["project:stand", "none", [], []],
-  ["project:manage", "none", [], ["project:stand", "records:read.all", "records:create", "records:write.all", "records:delete.all", "records:publish.all", "records:attribute", "search:read", "embeddings:read", "embeddings:write", "schemas:read", "drafts:read", "files:read.all", "files:write.all", "files:delete.all", "users:read.all", "identities:read", "users:create", "identities:delete", "users:write.all", "users:setup", "users:delete.all", "notifications:read.all", "notifications:write.all", "notifications:consent", "pushcredentials:read", "pushcredentials:write", "notes:read.all", "notes:write.all", "notes:create", "approvals:read", "approvals:write", "rooms:read", "rooms:write", "presence:read", "operations:read", "operations:execute", "operations:write", "appconfig:read", "schedules:read", "schedules:write", "hooks:read", "hooks:write", "auth:login_with_foir", "authclients:read", "authclients:write", "domains:read", "domains:write", "loginpages:read", "loginpages:write", "secrets:read", "secrets:list", "secrets:put", "secrets:delete", "appsecrets:read", "appsecrets:list", "appsecrets:put", "appsecrets:delete", "usersecrets:read", "usersecrets:list", "usersecrets:put", "usersecrets:delete", "opsecrets:read", "opsecrets:write", "settings:read", "settings:write", "designtokens:read", "designtokens:write", "models:read", "models:write", "configs:read", "configs:write", "signinproviders:read", "signinproviders:write", "apps:read", "apps:write", "events:read", "targeting:debug", "visitors:forward", "apikeys:read", "apikeys:write", "organizations:read", "organizations:create", "organizations:delete", "organizations:write", "organizations:reach", "members:read", "members:write", "roles:read", "roles:write", "projects:read", "projects:write", "audit:read"]],
+  ["project:manage", "none", [], ["project:stand", "records:read.all", "records:create", "records:write.all", "records:delete.all", "records:publish.all", "records:attribute", "search:read", "embeddings:read", "embeddings:write", "schemas:read", "drafts:read", "files:read.all", "files:write.all", "files:delete.all", "users:read.all", "identities:read", "users:create", "identities:delete", "users:write.all", "users:setup", "users:delete.all", "notifications:read.all", "notifications:write.all", "notifications:consent", "pushcredentials:read", "pushcredentials:write", "notes:read.all", "notes:write.all", "notes:create", "approvals:read", "approvals:write", "rooms:read", "rooms:write", "presence:read", "operations:read", "operations:execute", "operations:write", "agents:read", "agents:execute", "agents:write", "agenttools:execute", "brief:read", "brief:write", "appconfig:read", "schedules:read", "schedules:write", "hooks:read", "hooks:write", "authclients:read", "authclients:write", "domains:read", "domains:write", "loginpages:read", "loginpages:write", "secrets:read", "secrets:list", "secrets:put", "secrets:delete", "appsecrets:read", "appsecrets:list", "appsecrets:put", "appsecrets:delete", "usersecrets:read", "usersecrets:list", "usersecrets:put", "usersecrets:delete", "opsecrets:read", "opsecrets:write", "settings:read", "settings:write", "designtokens:read", "designtokens:write", "models:read", "models:write", "configs:read", "configs:write", "signinproviders:read", "signinproviders:write", "apps:read", "apps:write", "events:read", "targeting:debug", "visitors:forward", "apikeys:read", "apikeys:write", "organizations:read", "organizations:create", "organizations:delete", "organizations:write", "orgsettings:write", "organizations:reach", "members:read", "members:write", "roles:read", "roles:write", "projects:read", "projects:write", "audit:read"]],
   ["projects:create", "none", [], []],
   ["projects:delete", "none", [], []],
   ["tenants:read", "none", [], []],
@@ -111,7 +118,6 @@ var GRANT_TABLE = [
   ["usersecrets:list", "none", [], []],
   ["usersecrets:put", "none", [], []],
   ["usersecrets:delete", "none", [], []],
-  ["auth:login_with_foir", "none", [], []],
   ["signinproviders:read", "none", [], []],
   ["signinproviders:write", "none", [], []]
 ];

package/dist/react/FoirFeedback.d.ts

@@ -59,6 +59,23 @@ export interface FoirFeedbackProps {
      * with a backdrop, closed by Escape, the backdrop or its Close button.
      */
     layout?: 'inline' | 'dialog';
+    /**
+     * Show the button fixed in a corner of the viewport, rather than where the
+     * component is placed, with the inline panel opening above it. Default: where
+     * it is placed.
+     */
+    launcher?: 'bottom-right' | 'bottom-left';
+    /**
+     * Let the reader point at the part of the page they mean: a field the host
+     * marked with `subjects.field(record, key, { label })`. The note is then filed
+     * against that record and names the field, so a page showing two records (a
+     * menu and an article) files each comment against the right one.
+     *
+     * Needs `subjects`, and is offered only while the page shows a marked field.
+     * A mouse points by clicking; the keyboard by Tab and Enter; Escape cancels.
+     * Default false.
+     */
+    pointing?: boolean;
     /**
      * The built-in styles' colours, radius and type. See
      * `FoirFeedbackAppearance`: each is also a CSS custom property, so a
@@ -121,4 +138,4 @@ export interface FoirFeedbackAppearance {
     /** `--foir-feedback-font-size`. Default: inherited. */
     fontSize?: string;
 }
-export declare function FoirFeedback({ client, subjects, subject, label, triggerLabel, title, placeholder, defaultOpen, onSignIn, signIn, layout, appearance, onSubmitted, onVisitorSubmitted, onError, className, }: FoirFeedbackProps): import("react/jsx-runtime").JSX.Element;
+export declare function FoirFeedback({ client, subjects, subject, label, triggerLabel, title, placeholder, defaultOpen, onSignIn, signIn, layout, launcher, pointing, appearance, onSubmitted, onVisitorSubmitted, onError, className, }: FoirFeedbackProps): import("react/jsx-runtime").JSX.Element;

package/dist/react/FoirProvider.d.ts

@@ -28,10 +28,14 @@ export interface FoirContextValue {
         email: string;
         password: string;
     }): Promise<FoirUser>;
+    /**
+     * Start a sign-up: the address is mailed a code, and `signInWithOtp` with it
+     * finishes the account and signs them in.
+     */
     register(vars: {
         email: string;
         password: string;
-    }): Promise<FoirUser>;
+    }): Promise<void>;
     requestOtp(email: string): Promise<boolean>;
     signInWithOtp(vars: {
         email: string;
@@ -138,7 +142,7 @@ export declare function useFoirAuth(): {
     register: (vars: {
         email: string;
         password: string;
-    }) => Promise<FoirUser>;
+    }) => Promise<void>;
     requestOtp: (email: string) => Promise<boolean>;
     signInWithOtp: (vars: {
         email: string;

package/dist/react/SignIn.d.ts

@@ -2,7 +2,7 @@ import type { FoirUser } from '../auth';
 export interface SignInProps {
     /** `password` (default) or `otp` (email one-time code). Ignored when `hostedUrl` is set. */
     method?: 'password' | 'otp';
-    /** Render a single button that redirects to a hosted login page instead of an embedded form. */
+    /** Render a single button that redirects to the hosted sign-in page instead of an embedded form. */
     hostedUrl?: string;
     /** Show OAuth provider buttons below the form. Default true. */
     oauth?: boolean;
@@ -15,7 +15,7 @@ export interface SignInProps {
 /**
  * A drop-in user sign-in. Renders an email/password (or OTP) form and,
  * unless disabled, OAuth provider buttons. Set `hostedUrl` to instead render a
- * button that redirects to a hosted login page. All state is handled through
+ * button that redirects to the hosted sign-in page. All state is handled through
  * {@link FoirProvider}; on success it calls `onSignIn` and optionally navigates
  * to `afterSignInUrl`.
  */

package/dist/react/feedback-notes.d.ts

@@ -113,6 +113,8 @@ export interface FoirFeedbackSubmission {
      */
     subject: FoirSubject;
     body: string;
+    /** The field of the subject the reader pointed at, when they pointed at one. */
+    anchorField?: string;
     /** The still the visitor chose to attach, or null. */
     screenshot: FoirScreenCapture | null;
     /** Injectable for the presigned PUT. Defaults to `globalThis.fetch`. */
@@ -132,6 +134,11 @@ export interface FoirVisitorSubmission {
     /** What the note is about, as for a signed-in user's. */
     subject: FoirSubject;
     body: string;
+    /**
+     * The field of the subject the visitor pointed at. The data API takes a
+     * field the visitor can read and refuses any other.
+     */
+    anchorField?: string;
     /**
      * Where the project's team may reply, as the visitor typed it. Sent only
      * when it is not blank, and never verified by anyone.