84f73d33a0
* feat(widget): add restriction callback to restrict visibility and modification of widget kinds * fix: typecheck issue * chore: address pull request feedback
89 lines
3.2 KiB
TypeScript
89 lines
3.2 KiB
TypeScript
import type { LoaderComponent } from "next/dynamic";
|
|
import type { DefaultErrorData } from "@trpc/server/unstable-core-do-not-import";
|
|
|
|
import type { Session } from "@homarr/auth";
|
|
import type { IntegrationKind, WidgetKind } from "@homarr/definitions";
|
|
import type { ServerSettings } from "@homarr/server-settings";
|
|
import type { SettingsContextProps } from "@homarr/settings";
|
|
import type { stringOrTranslation } from "@homarr/translation";
|
|
import type { TablerIcon } from "@homarr/ui";
|
|
|
|
import type { WidgetImports } from ".";
|
|
import type { inferOptionsFromCreator, WidgetOptionsRecord } from "./options";
|
|
|
|
const createWithDynamicImport =
|
|
<TKind extends WidgetKind, TDefinition extends WidgetDefinition>(kind: TKind, definition: TDefinition) =>
|
|
(componentLoader: () => LoaderComponent<WidgetComponentProps<TKind>>) => ({
|
|
definition: {
|
|
...definition,
|
|
kind,
|
|
},
|
|
kind,
|
|
componentLoader,
|
|
});
|
|
|
|
export const createWidgetDefinition = <TKind extends WidgetKind, TDefinition extends WidgetDefinition>(
|
|
kind: TKind,
|
|
definition: TDefinition,
|
|
) => ({
|
|
withDynamicImport: createWithDynamicImport(kind, definition),
|
|
});
|
|
|
|
export interface WidgetDefinition {
|
|
icon: TablerIcon;
|
|
supportedIntegrations?: IntegrationKind[];
|
|
integrationsRequired?: boolean;
|
|
createOptions: (settings: SettingsContextProps) => WidgetOptionsRecord;
|
|
errors?: Partial<
|
|
Record<
|
|
DefaultErrorData["code"],
|
|
{
|
|
icon: TablerIcon;
|
|
message: stringOrTranslation;
|
|
hideLogsLink?: boolean;
|
|
}
|
|
>
|
|
>;
|
|
/**
|
|
* Callback that returns wheter or not the widget should be available to the user.
|
|
* The widget will not be available in the widget picker and saving with a new one of this kind will not be possible.
|
|
*
|
|
* @param props contain user information
|
|
* @returns restriction type
|
|
*/
|
|
restrict?: (props: { user: Session["user"] | null }) => RestrictionLevel;
|
|
}
|
|
|
|
/**
|
|
* none: The widget is fully available to the user.
|
|
* select: The widget is available to the user but not in the widget picker.
|
|
* all: The widget is not available to the user. As replacement a message will be shown at the widgets position.
|
|
*/
|
|
export type RestrictionLevel = "none" | "select" | "all";
|
|
|
|
export interface WidgetProps<TKind extends WidgetKind> {
|
|
options: inferOptionsFromCreator<WidgetOptionsRecordOf<TKind>>;
|
|
integrationIds: string[];
|
|
itemId: string | undefined; // undefined when in preview mode
|
|
}
|
|
|
|
export type WidgetComponentProps<TKind extends WidgetKind> = WidgetProps<TKind> & {
|
|
boardId: string | undefined; // undefined when in preview mode
|
|
isEditMode: boolean;
|
|
setOptions: ({ newOptions }: { newOptions: Partial<inferOptionsFromCreator<WidgetOptionsRecordOf<TKind>>> }) => void;
|
|
width: number;
|
|
height: number;
|
|
};
|
|
|
|
export type WidgetOptionsRecordOf<TKind extends WidgetKind> = WidgetImports[TKind]["definition"]["createOptions"];
|
|
|
|
/**
|
|
* The following type should only include values that can be available for user (including anonymous).
|
|
* Because they need to be provided to the client to for example set certain default values.
|
|
*/
|
|
export interface WidgetOptionsSettings {
|
|
server: {
|
|
board: Pick<ServerSettings["board"], "enableStatusByDefault" | "forceDisableStatus">;
|
|
};
|
|
}
|