ish-ui 1.0.2

package/src/markdownEditor/utils/index.ts

@@ -0,0 +1,48 @@
+/*
+ * Copyright ish group pty ltd 2020.
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the
+ * GNU Affero General Public License version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ */
+
+export type ContentMode = 'textile' | 'html' | 'md';
+
+export const CONTENT_MODES: {
+  id: ContentMode,
+  title: string
+}[] = [
+  { id: 'md', title: 'rich text' },
+  { id: 'textile', title: 'legacy' },
+  { id: 'html', title: 'advanced (html)' }
+];
+
+export const getContentMarker = text => {
+  if (!text) return CONTENT_MODES[0].id;
+  const match = text.match(/\s*{render:"(.*)"}/, '');
+  return match && match[1] ? match[1] : CONTENT_MODES[1].id;
+};
+
+export const removeContentMarker = text => {
+  if (!text) return text;
+  return text.replace(/\s*{render:.*/g, '');
+};
+
+export const addContentMarker = (text, contentMode) => (
+  `${text}
+  {render:"${contentMode}"}`
+);
+
+export const getEditorModeLabel = (mode: ContentMode) => {
+  switch (mode) {
+    case 'md':
+      return 'RICH';
+    case 'html':
+      return 'HTML';
+    case 'textile':
+      return 'LEGACY';
+  }
+};

package/src/model/AppBar.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright ish group pty ltd 2023.
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+ */
+
+import { ReactNode } from 'react';
+import { AnyArgFunction } from '@src/model/CommonFunctions';
+
+export interface AppBarAction {
+  action: AnyArgFunction;
+  icon: ReactNode;
+  tooltip: string;
+  confirmText?: string;
+  confirmButtonText?: string;
+  disabled?: boolean;
+  tooltipError?: boolean;
+}

package/src/model/CommomObjects.ts

@@ -0,0 +1,8 @@
+export type StringKeyObject<V = any> = { [key: string]: V };
+
+export type StringKeyAndValueObject = StringKeyObject<string>;
+
+// Helper type for creating types from string arrays
+export type StringValueType<T extends ReadonlyArray<unknown>> = T extends ReadonlyArray<infer ElementType>
+  ? ElementType
+  : never;

package/src/model/CommonFunctions.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright ish group pty ltd. All rights reserved. https://www.ish.com.au
+ * No copying or use of this code is allowed without permission in writing from ish.
+ */
+
+export type StringArgFunction = (arg: string) => void;
+
+export type BooleanArgFunction = (arg: boolean) => void;
+
+export type NumberArgFunction = (arg: number) => void;
+
+export type HTMLTagArgFunction = (arg: HTMLElement) => void;
+
+export type DateArgFunction = (arg: Date) => void;
+
+export type AnyArgFunction<R = void, A = any> = (...args: A[]) => R;
+
+export type NoArgFunction = () => void;
+
+export type PromiseReturnFunction = (...args: any[]) => Promise<any>;

package/src/model/Confirm.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright ish group pty ltd 2023.
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+ */
+
+import { ReactNode } from 'react';
+import { AnyArgFunction } from '@src/model/CommonFunctions';
+
+export interface ConfirmProps {
+  onCancel?: AnyArgFunction;
+  onConfirm?: AnyArgFunction;
+  title?: string;
+  confirmMessage?: ReactNode;
+  cancelButtonText?: string;
+  confirmButtonText?: string;
+  onCancelCustom?: AnyArgFunction;
+  confirmCustomComponent?: ReactNode;
+}
+
+export interface ConfirmState extends ConfirmProps {
+  open: boolean;
+}
+
+export type ShowConfirmCaller = (props: ConfirmProps) => any;

package/src/model/Fields.ts

@@ -0,0 +1,254 @@
+/*
+ * Copyright ish group pty ltd 2023.
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+ */
+
+import { ChangeEvent, DragEvent, FocusEvent, MutableRefObject, ReactElement, ReactNode } from 'react';
+import { Dispatch } from 'redux';
+import { InputProps } from '@mui/material/Input/Input';
+import { AnyArgFunction } from '@src/model/CommonFunctions';
+import { ShowConfirmCaller } from '@src/model/Confirm';
+
+export type EventHandler<Event> = (event: Event, name?: string) => void;
+
+export interface EventOrValueHandler<Event> extends EventHandler<Event> {
+  (value: any): void;
+}
+
+export interface TagLike {
+  id?: number;
+  name?: string;
+  color?: string;
+  system?: boolean;
+  urlPath?: string;
+  content?: string;
+  weight?: number;
+  taggedRecordsCount?: number;
+  childrenCount?: number;
+  created?: string;
+  modified?: string;
+  childTags?: TagLike[];
+}
+
+export interface MenuTag<T> {
+  active: boolean;
+  tagBody: T;
+  children: MenuTag<T>[];
+  parent?: MenuTag<T>;
+  entity?: string;
+  path?: string;
+  prefix?: string;
+  queryPrefix?: string;
+  indeterminate?: boolean;
+}
+
+export interface FieldInputProps {
+  checked?: boolean | undefined;
+  value: any;
+  name: string;
+  onBlur: EventOrValueHandler<FocusEvent<any>>;
+  onChange: EventOrValueHandler<ChangeEvent<any>>;
+  onDragStart: EventHandler<DragEvent<any>>;
+  onDrop: EventHandler<DragEvent<any>>;
+  onFocus: EventHandler<FocusEvent<any>>;
+}
+
+export interface FieldMetaProps {
+  active?: boolean | undefined;
+  dispatch: Dispatch<any>;
+  error?: any;
+  invalid: boolean;
+  touched: boolean;
+}
+
+export interface FieldClasses {
+  input?: string;
+  text?: string;
+  underline?: string;
+  label?: string;
+  selectMenu?: string;
+  loading?: string;
+  listbox?: string;
+}
+
+export interface SelectItemRendererProps<E = any> {
+  content: string;
+  data: E;
+  parentProps: any;
+  search?: string
+}
+
+export interface ColoredCheckboxFieldProps<IP, MP> {
+  input?: Partial<Omit<IP, 'onBlur'>> & { onBlur?: AnyArgFunction };
+  meta?: Partial<MP>;
+  color: string;
+  label?: string;
+  className?: string;
+  disabled?: boolean;
+}
+
+export interface EditInPlaceFieldProps<IP, MP> {
+  inputRef?: MutableRefObject<any>;
+  input?: Partial<Omit<IP, 'onBlur'>> & { onBlur?: AnyArgFunction };
+  meta?: Partial<MP>;
+  InputProps?: Partial<InputProps>;
+  label?: ReactNode,
+  maxLength?: number,
+  disabled?: boolean,
+  min?: string,
+  max?: string,
+  step?: string,
+  className?: string,
+  defaultValue?: any,
+  onKeyPress?: any,
+  placeholder?: string,
+  warning?: string,
+  labelAdornment?: any,
+  preformatDisplayValue?: any,
+  truncateLines?: number,
+  fieldClasses?: FieldClasses,
+  rightAligned?: boolean,
+  disableInputOffsets?: boolean,
+  onKeyDown?: any,
+  multiline?: boolean,
+  inline?: boolean,
+}
+
+export interface EditInPlaceDateTimeFieldProps<IP, MP> {
+  inputRef?: MutableRefObject<any>;
+  input?: Partial<Omit<IP, 'onBlur'>> & { onBlur?: AnyArgFunction };
+  meta?: Partial<MP>;
+  fieldClasses?: FieldClasses,
+  onKeyPress?: AnyArgFunction;
+  labelAdornment?: ReactNode;
+  processActionId?: string;
+  formatDate?: string;
+  formatTime?: string;
+  formatDateTime?: string;
+  defaultValue?: any;
+  timezone?: string;
+  label?: ReactNode,
+  formatValue?: string;
+  className?: string;
+  placeholder?: string;
+  warning?: string;
+  inline?: boolean;
+  disabled?: boolean;
+  persistValue?: boolean;
+  rightAligned?: boolean;
+}
+
+export interface EditInPlaceSearchSelectFieldProps<IP, MP> {
+  inputRef?: MutableRefObject<any>;
+  input?: Partial<Omit<IP, 'onBlur'>> & ({ onBlur?: AnyArgFunction });
+  meta?: Partial<MP>;
+  items?: any[];
+  label?: ReactNode,
+  disabled?: boolean;
+  className?: string;
+  labelAdornment?: any;
+  inline?: boolean;
+  rightAligned?: boolean;
+  loading?: boolean;
+  hideLabel?: boolean;
+  colors?: any;
+  creatable?: boolean;
+  endAdornment?: any;
+  allowEmpty?: boolean;
+  fieldClasses?: FieldClasses;
+  selectLabelCondition?: any;
+  selectFilterCondition?: any;
+  defaultValue?: any;
+  rowHeight?: number;
+  remoteRowCount?: number;
+  loadMoreRows?: AnyArgFunction;
+  onCreateOption?: AnyArgFunction;
+  itemRenderer?: (content, data, search, parentProps) => ReactElement;
+  valueRenderer?: (content, data, search, parentProps) => ReactElement;
+  onInputChange?: AnyArgFunction;
+  onClearRows?: AnyArgFunction;
+  onInnerValueChange?: AnyArgFunction;
+  selectValueMark?: string;
+  remoteData?: boolean;
+  disableUnderline?: boolean;
+  createLabel?: string;
+  selectLabelMark?: string;
+  returnType?: 'object' | 'string';
+  alwaysDisplayDefault?: boolean;
+  popperAnchor?: any;
+  placeholder?: string;
+  sort?: ((a: any, b: any) => number) | boolean;
+  sortPropKey?: string;
+  hasError?: boolean;
+  multiple?: boolean;
+  hideMenuOnNoResults?: boolean;
+  hideEditIcon?: boolean;
+  warning?: string;
+  categoryKey?: string;
+  selectAdornment?: { position: 'start' | 'end', content: ReactElement }
+}
+
+export interface CodeFieldProps<IP, MP> {
+  input?: Partial<Omit<IP, 'onBlur'>> & { onBlur?: AnyArgFunction };
+  meta?: Partial<MP>;
+  classes?: any;
+  className?: string;
+  errorMessage?: string;
+  disabled?: boolean;
+  onFocus?: AnyArgFunction;
+}
+
+export interface FormSwitchProps<IP> {
+  input?: Partial<Omit<IP, 'onBlur'>> & { onBlur?: AnyArgFunction };
+  color?: string;
+  disabled?: boolean;
+  stringValue?: boolean;
+  label?: ReactNode;
+  className?: string;
+  inline?: boolean;
+  onChangeHandler?: AnyArgFunction;
+  onClick?: AnyArgFunction;
+}
+
+export interface CheckboxFieldProps<IP> {
+  input?: Partial<Omit<IP, 'onBlur'>> & { onBlur?: AnyArgFunction };
+  color?: string;
+  disabled?: boolean;
+  stringValue?: boolean;
+  className?: string;
+  uncheckedClass?: string;
+  onChangeHandler?: AnyArgFunction;
+  stopPropagation?: boolean;
+}
+
+export interface TagsFieldProps<T, IP, MP>  extends EditInPlaceFieldProps<IP, MP>  {
+  tags: T[];
+  showConfirm?: ShowConfirmCaller;
+  classes?: any;
+  validateEntity?: string;
+}
+
+interface FormFieldBaseProps {
+  required?: boolean;
+  format?: AnyArgFunction;
+  onClick?: AnyArgFunction;
+
+  // Performance optimization property that handles field value rendering outside of Redux Form life circle.
+  // It is true by default
+  // Should be set to false when Redux Form lificircle handlers are used (onChange,onBlur and etc)
+  debounced?: boolean;
+}
+
+export type FormFieldProps =
+  ({ type: 'phone' | 'duration' | 'text' | 'multilineText' | 'password' | 'number' | 'file' | 'money' } & FormFieldBaseProps & EditInPlaceFieldProps<FieldInputProps, FieldMetaProps>)
+  | ({ type: 'select' } & FormFieldBaseProps & EditInPlaceSearchSelectFieldProps<FieldInputProps, FieldMetaProps>)
+  | ({ type: 'date' | 'time' | 'dateTime' } & FormFieldBaseProps & EditInPlaceDateTimeFieldProps<FieldInputProps, FieldMetaProps>)
+  | ({ type: 'code' } & FormFieldBaseProps & CodeFieldProps<FieldInputProps, FieldMetaProps>)
+  | ({ type: 'coloredCheckbox' } & FormFieldBaseProps & ColoredCheckboxFieldProps<FieldInputProps, FieldMetaProps>)
+  | ({ type: 'switch' } & FormFieldBaseProps & FormSwitchProps<FieldInputProps>)
+  | ({ type: 'checkbox' } & FormFieldBaseProps & CheckboxFieldProps<FieldInputProps>)
+  | ({ type: 'tags' } & FormFieldBaseProps & TagsFieldProps<TagLike, FieldInputProps, FieldMetaProps>)
+  | ({ type: 'stub' })

package/src/model/NestedEntity.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright ish group pty ltd. All rights reserved. https://www.ish.com.au
+ * No copying or use of this code is allowed without permission in writing from ish.
+ */
+
+export interface EntityType {
+  name: string;
+  count: number;
+  disabled?: boolean;
+  link?: string;
+  timetableLink?: string;
+  linkHandler?: any;
+  grayOut?: boolean;
+}

package/src/model/Theme.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright ish group pty ltd 2023.
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+ */
+
+import { Theme, Palette, SimplePaletteColorOptions, TypeText } from '@mui/material';
+import { StringKeyObject } from '@src/model/CommomObjects';
+
+enum ThemeValuesEnum {
+  'default',
+  'dark',
+  'monochrome',
+  'highcontrast'
+}
+
+export type ThemeValues = keyof typeof ThemeValuesEnum;
+
+export const DefaultThemeKey: ThemeValues = 'default';
+
+export const DarkThemeKey: ThemeValues = 'dark';
+export const MonochromeThemeKey: ThemeValues = 'monochrome';
+export const HighcontrastThemeKey: ThemeValues = 'highcontrast';
+
+type ColorGetter = string | ((props: {}) => string);
+
+type TextExtended = TypeText & { primaryEditable: string; hint: string; grey: string };
+
+export interface AppTheme extends Theme {
+  heading: StringKeyObject<ColorGetter>;
+  blog: StringKeyObject<StringKeyObject<ColorGetter>>;
+  share: StringKeyObject<StringKeyObject<ColorGetter>>;
+  statistics: StringKeyObject<StringKeyObject<ColorGetter>>;
+  appBar: StringKeyObject<StringKeyObject<ColorGetter>>;
+  appBarButton: StringKeyObject<StringKeyObject<ColorGetter>>;
+  tabList: StringKeyObject<StringKeyObject<ColorGetter>>;
+  table: StringKeyObject<SimplePaletteColorOptions>;
+  palette: Palette & { text: TextExtended };
+  addButtonColor: StringKeyObject<ColorGetter>;
+}

package/src/model/index.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright ish group pty ltd 2023.
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+ */
+
+
+export * from './AppBar';
+export * from './Confirm';
+export * from './Fields';
+export * from './NestedEntity';
+export * from './Theme';
+export * from './CommomObjects';
+export * from './CommonFunctions';