@drawbridge/components 0.0.78 → 0.1.1

package/types/dashboard/form-admin-invoice-refund.d.ts

@@ -0,0 +1,16 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminInvoiceRefundProps {
+	// Called with the amount in cents; the page confirms and refunds.
+	onSuccess: ( values: { amount: number } ) => void;
+	values?: {
+		currency?: string;
+		// The most that can still be refunded, in cents.
+		refund?: number;
+		[ key: string ]: unknown;
+	};
+}
+
+declare const FormAdminInvoiceRefund: ComponentType<FormAdminInvoiceRefundProps>;
+
+export default FormAdminInvoiceRefund;

package/types/dashboard/form-admin-oauth.d.ts

@@ -0,0 +1,20 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminOauthValues {
+	description?: string | null;
+	// Set: PATCH /admin/oauth/clients/:id; unset: POST /admin/oauth/clients.
+	id?: string;
+	name?: string;
+	redirects?: string[];
+	scopes?: string[];
+}
+
+export interface FormAdminOauthProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: FormAdminOauthValues;
+}
+
+declare const FormAdminOauth: ComponentType<FormAdminOauthProps>;
+
+export default FormAdminOauth;

package/types/dashboard/form-admin-organization.d.ts

@@ -0,0 +1,17 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminOrganizationProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: {
+		id?: string;
+		status?: string;
+		title?: string;
+		version?: { current?: number };
+		[ key: string ]: unknown;
+	};
+}
+
+declare const FormAdminOrganization: ComponentType<FormAdminOrganizationProps>;
+
+export default FormAdminOrganization;

package/types/dashboard/form-admin-provider.d.ts

@@ -0,0 +1,33 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminProviderField {
+	input: 'text' | 'password' | 'email' | 'switch' | string;
+	key: string;
+	label: string;
+	// A stored secret's recognisable mask, e.g. 'kls••••••••9f3a'.
+	mask?: string | null;
+	message?: string | null;
+	redact?: boolean;
+	required?: boolean;
+	// Whether a value is stored.
+	set?: boolean;
+}
+
+export interface FormAdminProviderProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: {
+		enabled?: boolean;
+		fields?: FormAdminProviderField[];
+		live?: boolean;
+		// Plain fields only: a secret never comes back.
+		settings?: Record<string, unknown>;
+		slug?: string;
+		title?: string;
+		[ key: string ]: unknown;
+	};
+}
+
+declare const FormAdminProvider: ComponentType<FormAdminProviderProps>;
+
+export default FormAdminProvider;

package/types/dashboard/form-admin-referrer.d.ts

@@ -0,0 +1,18 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminReferrerProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: {
+		// Shown only when editing.
+		contract?: string | null;
+		// Set: PUT /admin/referrer/:id; unset: POST and the slug follows the title.
+		id?: string;
+		slug?: string;
+		title?: string;
+	};
+}
+
+declare const FormAdminReferrer: ComponentType<FormAdminReferrerProps>;
+
+export default FormAdminReferrer;

package/types/dashboard/form-admin-subscription-custom.d.ts

@@ -0,0 +1,31 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminSubscriptionCustomPlan {
+	available?: boolean;
+	// Percent.
+	conversion?: number;
+	// Cents per billing period.
+	data?: { amount?: number };
+	features?: { granted?: string[] };
+	// Storage in bytes.
+	limits?: { organization?: { actions?: number; members?: number; storage?: number } };
+	// Cents per action.
+	overages?: number;
+	title?: string;
+}
+
+export interface FormAdminSubscriptionCustomProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: {
+		custom?: FormAdminSubscriptionCustomPlan;
+		id?: string;
+		organization?: string;
+		// 'active' locks Available on.
+		status?: string;
+	};
+}
+
+declare const FormAdminSubscriptionCustom: ComponentType<FormAdminSubscriptionCustomProps>;
+
+export default FormAdminSubscriptionCustom;

package/types/dashboard/form-admin-template.d.ts

@@ -0,0 +1,16 @@
+import { ComponentType } from 'react';
+import { CardTemplatePage } from './card-template';
+
+export interface FormAdminTemplatePageProps {
+	disabled?: boolean;
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	// Set id: PUT /admin/template/:id with the style fields; unset: POST, copy only.
+	values?: {
+		id?: string;
+		page?: CardTemplatePage & { industry?: { key?: string; value?: string } };
+		[ key: string ]: unknown;
+	};
+}
+
+export declare const FormAdminTemplatePage: ComponentType<FormAdminTemplatePageProps>;

package/types/dashboard/form-admin-user-credit.d.ts

@@ -0,0 +1,12 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminUserCreditProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	// amount in cents, 500 to 10000.
+	values?: { amount?: number; id?: string };
+}
+
+declare const FormAdminUserCredit: ComponentType<FormAdminUserCreditProps>;
+
+export default FormAdminUserCredit;

package/types/dashboard/form-admin-user-permissions.d.ts

@@ -0,0 +1,16 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminUserPermissionsProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: {
+		id?: string;
+		// From GET /admin/user/:id (enums.user.permission.options).
+		permissionOptions?: { key: string; value: string }[];
+		permissions?: string[];
+	};
+}
+
+declare const FormAdminUserPermissions: ComponentType<FormAdminUserPermissionsProps>;
+
+export default FormAdminUserPermissions;

package/types/dashboard/form-admin-user-status.d.ts

@@ -0,0 +1,11 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminUserStatusProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: { id?: string; status?: string; [ key: string ]: unknown };
+}
+
+declare const FormAdminUserStatus: ComponentType<FormAdminUserStatusProps>;
+
+export default FormAdminUserStatus;

package/types/dashboard/form-admin-utm.d.ts

@@ -0,0 +1,39 @@
+import { ComponentType } from 'react';
+
+export interface FormAdminUtmPhone {
+	country?: string | null;
+	number?: string | null;
+}
+
+export interface FormAdminUtmParameters {
+	campaign?: string | null;
+	content?: string | null;
+	// The ads campaign id, shown read-only on edit.
+	id?: string | null;
+	medium?: string | null;
+	source?: string | null;
+	term?: string | null;
+}
+
+// With an id the form edits (PUT /admin/utm/:id, adding description and the
+// campaign parameters); without one it creates (POST /admin/utm).
+export interface FormAdminUtmValues {
+	description?: string | null;
+	id?: string;
+	parameters?: FormAdminUtmParameters | null;
+	phone?: FormAdminUtmPhone | null;
+	title?: string;
+	type?: 'phone' | 'url';
+	url?: string | null;
+	[ key: string ]: unknown;
+}
+
+export interface FormAdminUtmProps {
+	onError: ( error: Error & { status?: number; data?: unknown } ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: FormAdminUtmValues;
+}
+
+declare const FormAdminUtm: ComponentType<FormAdminUtmProps>;
+
+export default FormAdminUtm;

package/types/dashboard/form-ai.d.ts

@@ -0,0 +1,64 @@
+import { ComponentType, ReactNode } from 'react';
+
+type ApiError = Error & { status?: number; data?: unknown };
+
+export interface FormAiBrandProps {
+	disabled?: boolean;
+	onError: ( error: ApiError ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: { organization?: string; title?: string | null; url?: string; [ key: string ]: unknown };
+}
+
+export interface FormAiCampaignProps {
+	disabled?: boolean;
+	onError: ( error: ApiError ) => void;
+	onSuccess: ( response: unknown ) => void;
+	// type defaults to 'giveaway'; the options come from the cached [ 'app' ] enums.
+	values?: { organization?: string; title?: string | null; type?: string; url?: string; [ key: string ]: unknown };
+}
+
+export interface FormAiImageProps {
+	// Rendered above the prompt.
+	children?: ReactNode;
+	disabled?: boolean;
+	// Accepted but unused: a failure is shown in the form.
+	onError?: ( error: ApiError ) => void;
+	onSuccess: ( response: unknown ) => void;
+	// Spread into the request body alongside the prompt.
+	values?: { organization?: string; prompt?: string; [ key: string ]: unknown };
+}
+
+export interface FormAiPageProps {
+	// Shows the brand picker.
+	canManageBrands?: boolean;
+	disabled?: boolean;
+	onError: ( error: ApiError ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: {
+		brand?: { id: string; title?: string; [ key: string ]: unknown } | null;
+		campaign?: string;
+		organization?: string;
+		title?: string;
+		url?: string;
+		[ key: string ]: unknown;
+	};
+}
+
+export interface FormAiTextContext {
+	callback: string;
+	instruction: string;
+	title: string;
+}
+
+export interface FormAiTextProps {
+	disabled?: boolean;
+	// Called with the generated text when "Use this response" is pressed.
+	onChange?: ( content: string ) => void;
+	values?: { context?: FormAiTextContext; limit?: number; organization?: string; value?: string; [ key: string ]: unknown };
+}
+
+export const FormAiBrand: ComponentType<FormAiBrandProps>;
+export const FormAiCampaign: ComponentType<FormAiCampaignProps>;
+export const FormAiImage: ComponentType<FormAiImageProps>;
+export const FormAiPage: ComponentType<FormAiPageProps>;
+export const FormAiText: ComponentType<FormAiTextProps>;

package/types/dashboard/form-auth.d.ts

@@ -0,0 +1,64 @@
+import { ComponentType } from 'react';
+
+// Campaign tags read off the auth page's query string (lib/utm utmFromParams).
+export interface FormAuthUtm {
+	campaign?: string;
+	click?: { fbclid?: string; gclid?: string; liFatId?: string; msclkid?: string; ttclid?: string };
+	content?: string;
+	id?: string;
+	medium?: string;
+	source?: string;
+	term?: string;
+}
+
+// `body` is the request as sent, so Resend can replay it with a fresh token.
+export interface FormAuthRequested<Body> {
+	body: Body;
+	otcId: string;
+}
+
+export interface FormAuthEmailProps {
+	// The button label.
+	action?: string;
+	onSuccess: ( requested: FormAuthRequested<{ email: string }> ) => void;
+	values?: { email?: string };
+}
+
+export interface FormAuthSignupBody {
+	email: string;
+	firstName: string;
+	lastName: string;
+	referrer?: string;
+	utm?: FormAuthUtm;
+}
+
+export interface FormAuthSignupProps {
+	action?: string;
+	onSuccess: ( requested: FormAuthRequested<FormAuthSignupBody> ) => void;
+	referrer?: string;
+	utm?: FormAuthUtm | null;
+	values?: { email?: string; firstName?: string; lastName?: string };
+}
+
+export interface FormAuthResendProps {
+	// The reCAPTCHA action of the original request ('form_auth_signin' / 'form_auth_signup').
+	action: string;
+	body: Record<string, unknown>;
+	endpoint: string;
+	// The new otcId: the old one stops working once this succeeds.
+	onSuccess: ( otcId: string ) => void;
+}
+
+export interface FormProvidersProps {
+	// The Google button label.
+	action?: string;
+	redirectTo?: string;
+	referrer?: string;
+	utm?: FormAuthUtm | null;
+}
+
+// All of them call useGoogleReCaptcha: render inside ProviderRecaptcha.
+export const FormAuthEmail: ComponentType<FormAuthEmailProps>;
+export const FormAuthSignup: ComponentType<FormAuthSignupProps>;
+export const FormAuthResend: ComponentType<FormAuthResendProps>;
+export const FormProviders: ComponentType<FormProvidersProps>;

package/types/dashboard/form-credit.d.ts

@@ -0,0 +1,10 @@
+import { ComponentType } from 'react';
+
+export interface FormCreditProps {
+	// Called with the credit amount picked: 10, 25, 50, 75, 100 or 1000.
+	onChange: ( value: number ) => void;
+}
+
+declare const FormCredit: ComponentType<FormCreditProps>;
+
+export default FormCredit;

package/types/dashboard/form-file-upload.d.ts

@@ -0,0 +1,16 @@
+import { ComponentType } from 'react';
+
+export interface FormFileUploadProps {
+	// Files post to endpoint + '/file/:type/:extension' (under 50MB) or
+	// endpoint + '/file/upload/...' (presigned multipart, 50MB and over).
+	endpoint: string;
+	// Video ceiling in bytes; defaults to the shared cap the api enforces.
+	maximumUploadBytes?: number;
+	onSuccess: ( response: unknown ) => void;
+	// Which formats are accepted: 'all' | 'media' | 'image' | 'video' | 'application'.
+	type?: string;
+}
+
+declare const FormFileUpload: ComponentType<FormFileUploadProps>;
+
+export default FormFileUpload;

package/types/dashboard/form-file.d.ts

@@ -0,0 +1,33 @@
+import { ComponentType } from 'react';
+
+export interface FormFileItem {
+	extension?: string;
+	filename?: string;
+	frames?: { sizes?: Record<string, string> }[];
+	id: string;
+	mimetype: string;
+	poster?: number;
+	sizes?: Record<string, string>;
+	updatedAt?: string;
+	[ key: string ]: unknown;
+}
+
+export interface FormFileProps {
+	// The library lists endpoint + '/files'; uploads post under it.
+	endpoint: string;
+	// Extra list filters for the library.
+	filters?: Record<string, unknown>;
+	onError?: ( error: Error ) => void;
+	// A library file was picked.
+	onChange?: ( file: FormFileItem ) => void;
+	// Upload or generate finished; without it the form returns to its first tab.
+	onUpload?: ( response: unknown ) => void;
+	// Generate posts to /organization/:id/ai/image.
+	organization?: { id: string; [ key: string ]: unknown };
+	tabs?: ( 'library' | 'upload' | 'generate' )[];
+	type?: string;
+}
+
+declare const FormFile: ComponentType<FormFileProps>;
+
+export default FormFile;

package/types/dashboard/form-filters-analytics.d.ts

@@ -0,0 +1,40 @@
+import { ComponentType, ReactNode } from 'react';
+
+export interface FormFiltersAnalyticsInput {
+	key: string;
+	label: string;
+	options?: { key: string; value: unknown }[];
+	searchable?: boolean;
+	type?: 'date' | string;
+}
+
+export interface FormFiltersAnalyticsResource {
+	endpoint: string;
+	key: string;
+	label: string;
+	model: string;
+	multiple?: boolean;
+	params?: Record<string, unknown>;
+	render?: ( item: any ) => ReactNode;
+}
+
+export interface FormFiltersAnalyticsInputs {
+	// Accepted but not rendered: the Custom Range tab draws its own range picker.
+	dateRange?: FormFiltersAnalyticsInput[];
+	filters?: FormFiltersAnalyticsInput[];
+	monthYear?: FormFiltersAnalyticsInput[];
+	resources?: FormFiltersAnalyticsResource[];
+}
+
+export interface FormFiltersAnalyticsProps {
+	// A saved start opens the Custom Range tab; month and year default to now.
+	filters?: Record<string, unknown>;
+	inputs: FormFiltersAnalyticsInputs;
+	onReset?: () => void;
+	// Resources reduced to ids, and only the active date mode's keys.
+	onSuccess: ( result: { filters: Record<string, unknown> } ) => void;
+}
+
+declare const FormFiltersAnalytics: ComponentType<FormFiltersAnalyticsProps>;
+
+export default FormFiltersAnalytics;

package/types/dashboard/form-filters.d.ts

@@ -0,0 +1,70 @@
+import { ComponentType, ReactNode } from 'react';
+
+export interface FormFiltersOption {
+	key: string;
+	value: unknown;
+}
+
+export interface FormFiltersInput {
+	// A custom input; defaults to InputCombobox with `options`.
+	element?: ComponentType<any>;
+	// Turns the picked value into the query value (String, Number, ...).
+	formatter: ( value: any ) => unknown;
+	key: string;
+	label?: string;
+	options?: FormFiltersOption[];
+	props?: Record<string, unknown>;
+}
+
+export interface FormFiltersResource {
+	endpoint: string;
+	key: string;
+	label?: string;
+	model: string;
+	params?: Record<string, unknown>;
+	render?: ( item: any ) => ReactNode;
+	searchKeys?: string[];
+	// The chip label for a model with no title of its own (a user).
+	title?: ( item: any ) => string;
+}
+
+export interface FormFiltersInputs {
+	filters?: FormFiltersInput[];
+	range?: { label?: string };
+	refine?: FormFiltersInput[];
+	resources?: FormFiltersResource[];
+	search?: boolean;
+	sort?: FormFiltersOption[];
+}
+
+// The form's own state, handed back on submit so the drawer reopens as it was.
+export interface FormFiltersValues {
+	filters?: Record<string, { key: string; value: unknown }>;
+	range?: { end?: string; start?: string };
+	refine?: Record<string, { key: string; value: unknown }>;
+	resources?: Record<string, { key: string; value: { id: string; title?: string } | null }>;
+}
+
+export interface FormFiltersResult {
+	filters: Record<string, unknown>;
+	limit?: number;
+	range: { end?: string; start?: string };
+	refine: Record<string, unknown>;
+	search?: string;
+	sort?: unknown;
+	values: FormFiltersValues;
+}
+
+export interface FormFiltersProps {
+	inputs: FormFiltersInputs;
+	limit?: number;
+	onReset?: () => void;
+	onSuccess: ( result: FormFiltersResult ) => void;
+	search?: string;
+	sort?: unknown;
+	values?: FormFiltersValues;
+}
+
+declare const FormFilters: ComponentType<FormFiltersProps>;
+
+export default FormFilters;

package/types/dashboard/form-note.d.ts

@@ -0,0 +1,15 @@
+import { ComponentType } from 'react';
+
+export interface FormNoteProps {
+	// The note posts to endpoint + '/note' ('/admin' posts to /admin/note).
+	endpoint?: string;
+	// Stored with the note: the ids it belongs to ({ organization, subscription, ... }).
+	meta?: Record<string, unknown>;
+	onError: ( error: Error & { status?: number; data?: unknown } ) => void;
+	onSuccess: ( response: unknown ) => void;
+	type?: 'admin' | 'public' | string;
+}
+
+declare const FormNote: ComponentType<FormNoteProps>;
+
+export default FormNote;

package/types/dashboard/form-notification.d.ts

@@ -0,0 +1,30 @@
+import { ComponentType } from 'react';
+
+import { Control, FormState, UseFormSetValue } from 'react-hook-form';
+
+// The subject + message pair (and its spam check card) inside a form it does
+// not own: it registers `${ name }.subject`, `.message`, `.text` and `.score`
+// on the host form's control.
+export interface FormNotificationProps {
+	control: Control<any>;
+	disabled?: boolean;
+	formState?: FormState<any>;
+	// Stable (useCallback): called with the row key and whether a spam check is in flight.
+	onChecking?: ( key: string, checking: boolean ) => void;
+	setValue: UseFormSetValue<any>;
+	values: {
+		// The field-array row id, when there is more than one pair in the form.
+		id?: string;
+		// The path prefix: 'notifications.draw' or `steps.${ index }`.
+		name: string;
+		// Billed for the spam check.
+		organization: string;
+		// Tokens the editor can insert.
+		variables?: Array<{ key: string; label: string }>;
+		[ key: string ]: unknown;
+	};
+}
+
+export declare const FormNotification: ComponentType<FormNotificationProps>;
+
+export default FormNotification;

package/types/dashboard/form-organization-affiliate.d.ts

@@ -0,0 +1,29 @@
+import { ComponentType } from 'react';
+
+// Creating: a title only.
+export interface FormOrganizationAffiliateProps {
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: { organization: string; title?: string; [ key: string ]: unknown };
+}
+
+// Managing: a custom slug offers to revert to `shortId`, which keeps working.
+export interface FormOrganizationAffiliateEditProps {
+	disabled?: boolean;
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: {
+		id: string;
+		organization: string;
+		shortId?: string;
+		slug?: string;
+		title?: string;
+		[ key: string ]: unknown;
+	};
+}
+
+export declare const FormOrganizationAffiliateEdit: ComponentType<FormOrganizationAffiliateEditProps>;
+
+declare const FormOrganizationAffiliate: ComponentType<FormOrganizationAffiliateProps>;
+
+export default FormOrganizationAffiliate;

package/types/dashboard/form-organization-brand.d.ts

@@ -0,0 +1,37 @@
+import { ComponentType } from 'react';
+
+// Creating: a title only.
+export interface FormOrganizationBrandProps {
+	disabled?: boolean;
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	values?: { organization: string; title?: string; [ key: string ]: unknown };
+}
+
+// Managing: title, images and style. The style section reads the font
+// catalog from the [ 'app' ] query.
+export interface FormOrganizationBrandEditProps {
+	disabled?: boolean;
+	onError: ( error: Error ) => void;
+	onSuccess: ( response: unknown ) => void;
+	// The organization record, handed to the file pickers.
+	organization?: { id: string; [ key: string ]: unknown };
+	values?: {
+		id: string;
+		images?: {
+			logo?: { id: string; [ key: string ]: unknown } | null;
+			preview?: { id: string; [ key: string ]: unknown } | null;
+		};
+		organization: string;
+		style?: Record<string, unknown>;
+		title?: string;
+		// The brand's page address, shown read-only.
+		url?: string;
+		[ key: string ]: unknown;
+	};
+}
+
+// The module has no default export.
+export declare const FormOrganizationBrand: ComponentType<FormOrganizationBrandProps>;
+
+export declare const FormOrganizationBrandEdit: ComponentType<FormOrganizationBrandEditProps>;