sp-react-formfields/src/interfaces.ts

Collection of React controls used for rendering SharePoint fields in custom forms. Support new/edit/display rendering modes.

import { SPRest, AttachmentFileInfo } from '@pnp/sp';
import { BaseFieldRenderer } from './fields';

export interface IFormMode {
  New: number,
  Display: number,
  Edit: number
}

export const FormMode: IFormMode = {
  New: 1, Display: 2, Edit: 3
};

export interface IListFormProps {
  CurrentListId?: string;
  CurrentItemId?: number;
  SpWebUrl?: string;
  CurrentMode: number;
  IsLoading?: boolean;
  IsSaving?: boolean;
  pnpSPRest?: SPRest;
}

export interface IFormMessage {
  Text: string;
  DialogCallback?: (globalState: IFormManagerProps) => void;
}

export interface IFormManagerProps {
  PnPSPRest?: SPRest;
  SPWebUrl: string;
  CurrentListId: string;
  CurrentListDefaultViewUrl: string;
  CurrentMode: number;
  CurrentItemId?: number;
  Fields?: IFieldProps[];
  IsLoading: boolean;
  ShowValidationErrors: boolean;
  ETag: string;
  GlobalMessage?: IFormMessage;
}

export interface IFormManagerActions {
  getState(): IFormManagerProps;
  initStore(sPWebUrl: string, currentListId: string, currentMode: number, currentItemId?: number, contentTypeId?: string): Promise<IFormManagerProps>;
  setLoading(isLoading: boolean);
  setFormMode(mode: number): void;
  setItemId(itemId: number): void;
  setFieldData(internalName: string, newValue: any): void;
  setFieldValidationState(internalName: string, isValid: boolean, validationErrors: string[]);
  setFieldPropValue(internalName: string, propName: string, propValue: any);
  addNewAttachmentInfo(fileInfo: any): void;
  removeNewAttachmentInfo(fileInfo: any): void;
  addOrRemoveExistingAttachmentDeletion(attachmentName: string): void;
  getFieldControlValuesForPost(): Promise<Object>;
  getNewAttachmentsToSave(): Promise<AttachmentFileInfo[]>;
  clearHelperAttachmentProperties(): void;
  saveFormData(): Promise<ISaveItemResult>;
  validateForm(): boolean; // IValidateFormResult;
  setShowValidationErrors(show: boolean): void;
  addValidatorToField(validator: Function, internalName: string, ...validatorParams: any[]): void;
  clearValidatorsFromField(internalName: string): void;
  setFormMessage(message: string, callback: () => void): void;
}

export interface IFormFieldLabelProps {
  InternalName: string;
}

export interface IFormFieldProps {
  InternalName: string;
  FormMode?: number;
  CustomValidators?: Function[];
}

export interface IValidateFieldResult {
  IsValid: boolean;
  ValidationErrors: string[];
}

export interface ISaveItemResult {
  IsSuccessful: boolean;
  Error?: string;
  ItemId: number;
  RestObject: object;
  ETag: string;
}

export interface IFieldProps {
  SchemaXml: XMLDocument;
  Title: string;
  InternalName: string;
  EntityPropertyName: string;
  IsMulti: boolean;
  IsHidden: boolean;
  IsRequired: boolean;
  FormFieldValue: any;
  DefaultValue?: any;
  Max?: number;
  Min?: number;
  Type: string;
  Description: string;
  IsRichText?: boolean;
  Choices?: string[];
  FillInChoice?: boolean;
  LookupListId?: string;
  LookupWebId?: string;
  LookupField?: string;
  TaxonomyTermSetId?: string;
  TaxonomyAnchorId?: string;
  TaxonomyIsOpen?: boolean;
  TaxonomyUpdateFieldEntityPropertyName?: string;
  UserSelectionMode?: string;
  NumberIsPercent?: boolean;
  DateTimeIsTimePresent?: boolean;
  CurrencyLocaleId?: number;
  UrlRenderAsPicture?: boolean;
  AttachmentsNewToAdd?: any[];
  AttachmentsExistingToDelete?: any[];
  CurrentMode: number;
  CurrentListId: string;
  ShowValidationErrors: boolean;
  pnpSPRest: SPRest;
  Validators?: Function[];
  IsValid?: boolean;
  ValidationErrors?: string[];
  saveChangedFieldData?(fieldInternalName: string, newValue: any): void;
  getFieldRendererObject?(fieldRenderer: BaseFieldRenderer): void;
}

export interface ICreateFieldRendererConfig {
  FieldRendererComponent: BaseFieldRenderer;
  FieldRendererProps: IFieldProps;
}

export interface IValidationManager {
  defaultValidators: {
    required(internalName: string): string,
    mustMatch(internalName1: string, internalName2: string): string,
    minLength(internalName: string, length: number): string,
    maxLength(internaName: string, length: number): string,
    minValue(internalName: string, minValue: number): string,
    maxValue(internaName: string, maxValue: number): string
  };
  validateField(fieldProps: IFieldProps): IValidateFieldResult;
}

export const getQueryString = (url, field) => {
  let href = url ? url : window.location.href;
  let reg = new RegExp('[?&]' + field + '=([^&#]*)', 'i');
  let s = reg.exec(href);
  return s ? s[1] : null;
};

export const executeSPQuery = async (ctx: SP.ClientRuntimeContext): Promise<any> => {
  let promise = new Promise<any>((resolve, reject) => {
    ctx.executeQueryAsync((sender, args) => {
      resolve();
    }, (sender, args) => {
      reject(args.get_message());
    });
  });
  return promise;
};

// User 'application/json;odata=verbose' for compatibility with SP2013
export const ODataMode = 'application/json;odata=verbose';
// export const ODataMode = 'application/json;odata=minimalmetadata';

export const setupPnp = (sp: SPRest, webUrl) => {
  sp.setup({
    sp: {
      headers: {
        Accept: ODataMode
      },
      baseUrl: webUrl
    }
  });
};