@knaw-huc/panoptes-react-blocks 0.0.1

package/dist/components/blocks/json/index.d.ts

@@ -0,0 +1,18 @@
+import { Block } from '@knaw-huc/panoptes-react';
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+export type JsonObject = {
+    [key: string]: JsonValue;
+};
+export type JsonArray = JsonValue[];
+export type JsonData = JsonValue;
+export type JsonSchema = JsonObject;
+export interface JsonBlock extends Block {
+    type: "json";
+    value: JsonData;
+    config: JsonSchema;
+}
+declare const RenderJsonBlock: ({ block }: {
+    block: Block;
+}) => import("react/jsx-runtime").JSX.Element;
+export default RenderJsonBlock;

package/dist/components/blocks/json/schemaSelectors.d.ts

@@ -0,0 +1,7 @@
+import { JsonSchema } from './index.tsx';
+export declare function deepGet(obj: any, path: string, defaultValue?: any): any;
+export declare const omitProperty: (schema: JsonSchema, propertyName: string) => boolean;
+export declare const isLink: (schema: JsonSchema, propertyName: string) => boolean;
+export declare const isExternalLink: (schema: JsonSchema, propertyName: string) => boolean;
+export declare const isMarkdownHTML: (schema: JsonSchema, propertyName: string) => boolean;
+export declare const getLinkTo: (schema: JsonSchema, propertyName: string) => string;

package/dist/components/blocks/label/index.d.ts

@@ -0,0 +1,8 @@
+import { Block } from '@knaw-huc/panoptes-react';
+export interface LabelBlock extends Block {
+    type: 'label';
+    value: string;
+}
+export default function LabelBlockRenderer({ block }: {
+    block: Block;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/blocks/link/index.d.ts

@@ -0,0 +1,13 @@
+import { Block } from '@knaw-huc/panoptes-react';
+export interface LinkBlockConfig {
+    url: string;
+}
+export interface LinkBlock extends Block {
+    type: 'link';
+    value: string;
+    config?: LinkBlockConfig;
+    model?: Record<string, unknown>;
+}
+export default function LinkBlockRenderer({ block }: {
+    block: Block;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/blocks/map/index.d.ts

@@ -0,0 +1,17 @@
+import { Block } from '@knaw-huc/panoptes-react';
+export interface MapBlockConfig {
+    zoom?: number;
+    tileUrl?: string;
+}
+export type MapBlockValue = {
+    latitude: number;
+    longitude: number;
+};
+export interface MapBlock extends Block {
+    type: "map";
+    value: MapBlockValue;
+    config?: MapBlockConfig;
+}
+export default function MapBlockRenderer({ block }: {
+    block: Block;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/blocks/markdown/index.d.ts

@@ -0,0 +1,8 @@
+import { Block } from '@knaw-huc/panoptes-react';
+export interface MarkDownBlock extends Block {
+    type: 'markdown';
+    value: string;
+}
+export default function MarkdownBlockRenderer({ block }: {
+    block: Block;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/blocks/screen/FormColumn.d.ts

@@ -0,0 +1,7 @@
+import { ColumnDefinition } from './schema';
+interface FormColumnProps {
+    column: ColumnDefinition;
+    groupId?: string;
+}
+export default function FormColumn({ column, groupId }: FormColumnProps): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/components/blocks/screen/FormElement.d.ts

@@ -0,0 +1,7 @@
+import { ElementDefinition } from './schema';
+interface FormElementProps {
+    element: ElementDefinition;
+    groupId?: string;
+}
+export default function FormElement({ element, groupId }: FormElementProps): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/components/blocks/screen/FormRow.d.ts

@@ -0,0 +1,7 @@
+import { RowDefinition } from './schema';
+interface FormRowProps {
+    row: RowDefinition;
+    inheritedGroupId?: string;
+}
+export default function FormRow({ row, inheritedGroupId }: FormRowProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/blocks/screen/ScreenActions.d.ts

@@ -0,0 +1 @@
+export default function ScreenActions(): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/blocks/screen/ScreenForm.d.ts

@@ -0,0 +1 @@
+export default function ScreenForm(): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/blocks/screen/ScreenLinks.d.ts

@@ -0,0 +1 @@
+export default function ScreenLinks(): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/blocks/screen/ScreenRenderer.d.ts

@@ -0,0 +1 @@
+export default function ScreenRenderer(): import("react/jsx-runtime").JSX.Element;

package/dist/components/blocks/screen/ScreenSidebar.d.ts

@@ -0,0 +1,6 @@
+import { SidebarDefinition } from './schema';
+interface ScreenSidebarProps {
+    sidebar: SidebarDefinition;
+}
+export default function ScreenSidebar({ sidebar }: ScreenSidebarProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/blocks/screen/ScreenTabs.d.ts

@@ -0,0 +1 @@
+export default function ScreenTabs(): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/blocks/screen/context/ItemDataContext.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+declare const ItemDataContext: import('react').Context<Record<string, unknown> | null>;
+export declare function ItemDataProvider({ item, children }: {
+    item: Record<string, unknown>;
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export default ItemDataContext;

package/dist/components/blocks/screen/context/ScreenContext.d.ts

@@ -0,0 +1,16 @@
+import { ReactNode } from 'react';
+import { ScreenDefinition } from '../schema';
+export interface ScreenContextValue {
+    screenDefinition: ScreenDefinition;
+    data: Record<string, unknown>;
+    activeTabId: string;
+    setActiveTabId: (tabId: string) => void;
+}
+declare const ScreenContext: import('react').Context<ScreenContextValue | null>;
+export interface ScreenProviderProps {
+    screenDefinition: ScreenDefinition;
+    data: Record<string, unknown>;
+    children: ReactNode;
+}
+export declare function ScreenProvider({ screenDefinition, data, children }: ScreenProviderProps): import("react/jsx-runtime").JSX.Element;
+export default ScreenContext;

package/dist/components/blocks/screen/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export { default as useElementState } from './useElementState';
+export { default as useScreenContext } from './useScreenContext';
+export { default as useScreenState } from './useScreenState';

package/dist/components/blocks/screen/hooks/useElementState.d.ts

@@ -0,0 +1,8 @@
+import { ElementDefinition } from '../schema';
+export default function useElementState(element: ElementDefinition, groupId?: string): {
+    value: unknown;
+    hidden: boolean;
+    label: string | undefined;
+    infoLabel: string | undefined;
+    config: Record<string, unknown> | undefined;
+};

package/dist/components/blocks/screen/hooks/useItemData.d.ts

@@ -0,0 +1 @@
+export declare function useItemData(): Record<string, unknown> | null;

package/dist/components/blocks/screen/hooks/useScreenContext.d.ts

@@ -0,0 +1,2 @@
+import { ScreenContextValue } from '../context/ScreenContext.tsx';
+export default function useScreenContext(): ScreenContextValue;

package/dist/components/blocks/screen/hooks/useScreenState.d.ts

@@ -0,0 +1,3 @@
+export default function useScreenState(): {
+    getValue: (expression: string) => unknown;
+};

package/dist/components/blocks/screen/index.d.ts

@@ -0,0 +1,6 @@
+import { Block } from '@knaw-huc/panoptes-react';
+interface RenderScreenBlockProps {
+    block: Block;
+}
+declare const RenderScreenBlock: ({ block }: RenderScreenBlockProps) => import("react/jsx-runtime").JSX.Element;
+export default RenderScreenBlock;

package/dist/components/blocks/screen/schema/binding.d.ts

@@ -0,0 +1,8 @@
+export interface ParsedBinding {
+    source: 'data' | 'itemData';
+    path: string[];
+    rawPath: string;
+}
+export declare function isBindingExpression(value: string): boolean;
+export declare function parseBinding(expression: string): ParsedBinding;
+export declare function getNestedValue(obj: unknown, path: string[]): unknown;

package/dist/components/blocks/screen/schema/index.d.ts

@@ -0,0 +1,3 @@
+export type { ScreenDefinition, ScreenType, TabDefinition, OperationListItem, OperationDefinition, LinkDefinition, ActionDefinition, ActivationType, ConfirmationDefinition, ConfirmationLabels, FormDefinition, RowDefinition, DisplayType, ColumnDefinition, ElementDefinition, SidebarDefinition, SidebarSectionDefinition, SidebarNavItemDefinition, ScreenBlock, ScreenBlockValue, } from './types';
+export { isBindingExpression, parseBinding, getNestedValue, } from './binding';
+export type { ParsedBinding } from './binding';

package/dist/components/blocks/screen/schema/types.d.ts

@@ -0,0 +1,100 @@
+import { Block } from '@knaw-huc/panoptes-react';
+export interface ScreenDefinition {
+    id: string;
+    label?: string;
+    activeTabId?: string;
+    screenType: ScreenType;
+    tabs?: TabDefinition[];
+    links?: LinkDefinition[];
+    actions: ActionDefinition[];
+    form: FormDefinition;
+    sidebar?: SidebarDefinition;
+}
+export interface SidebarDefinition {
+    id: string;
+    width?: string;
+    sections: SidebarSectionDefinition[];
+}
+export interface SidebarSectionDefinition {
+    id: string;
+    items: SidebarNavItemDefinition[];
+}
+export interface SidebarNavItemDefinition {
+    id: string;
+    icon: string;
+    label?: string;
+    operation: OperationDefinition;
+    active?: boolean;
+}
+export type ScreenType = 'normal';
+export interface TabDefinition {
+    id: string;
+    label?: string;
+    operation?: OperationDefinition;
+    operationList?: OperationListItem[];
+}
+export interface OperationListItem {
+    id: string;
+    label?: string;
+    operation: OperationDefinition;
+}
+export interface OperationDefinition {
+    operationId: string;
+    parameters: Record<string, string | number | boolean>;
+}
+export interface LinkDefinition {
+    id: string;
+    label: string;
+    operation?: OperationDefinition;
+    href?: string;
+}
+export interface ActionDefinition {
+    id: string;
+    label?: string;
+    activate: ActivationType;
+    confirmation: ConfirmationDefinition;
+    operation: OperationDefinition;
+}
+export type ActivationType = 'always' | 'onDirty' | 'onValid' | 'onDirtyAndValid';
+export interface ConfirmationDefinition {
+    askConfirmation: 'always' | 'never' | 'onDirty';
+    labels?: ConfirmationLabels;
+}
+export interface ConfirmationLabels {
+    title?: string;
+    message?: string;
+    ok?: string;
+    cancel?: string;
+}
+export interface FormDefinition {
+    rows: RowDefinition[];
+}
+export interface RowDefinition {
+    displayType?: DisplayType;
+    label?: string;
+    groupId?: string;
+    collapsible?: boolean;
+    defaultCollapsed?: boolean;
+    elements?: ElementDefinition[];
+    columns?: ColumnDefinition[];
+    rows?: RowDefinition[];
+}
+export type DisplayType = 'header' | 'group' | 'footer' | 'row';
+export interface ColumnDefinition {
+    elements: ElementDefinition[];
+}
+export interface ElementDefinition {
+    value: string | string[] | Record<string, string>;
+    hidden?: boolean;
+    addIndeterminate?: boolean;
+    label?: string;
+    infoLabel?: string;
+    type?: string;
+    config?: Record<string, unknown>;
+}
+export type ScreenBlockValue = Record<string, unknown>;
+export interface ScreenBlock extends Block {
+    type: 'screen';
+    value: ScreenBlockValue;
+    config: ScreenDefinition;
+}

package/dist/components/blocks/toggle/index.d.ts

@@ -0,0 +1,8 @@
+import { Block } from '@knaw-huc/panoptes-react';
+export interface ToggleBlock extends Block {
+    type: 'toggle';
+    value: boolean;
+}
+export default function ToggleBlockRenderer({ block }: {
+    block: Block;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/ghostline/Ghostline.d.ts

@@ -0,0 +1 @@
+export default function GhostLine(): import("react/jsx-runtime").JSX.Element;