canner/lib/components/types.js.flow

Build CMS in few lines of code for different data sources

// @flow
import type {ApolloClient} from "apollo-boost";
import * as React from 'react';

export type CannerSchema = {
  [string]: any
};

export type LoadedSchema = {
  schema: CannerSchema,
  pageSchema: CannerSchema,
  sidebar: Sidebar,
  visitors: Array<Object>,
  client: ApolloClient,
  connectors: {[string]: any},
  connector: any,
  resolvers: {[string]: any},
  graphqlClient: any,
  imageStorages: {[key: string]: any},
  fileStorages: {[key: string]: any},
  dict: Object
};
export type ComponentNode = any;

export type ComponentTree = {
  [string]: ComponentNode
}

export type DataDidChange = ({
  [key: string]: boolean | {[id: string]: any}
}) => void;

export type BeforeFetch = (
  key: string,
  {
    query: string,
    variables: Object,
    relation?: Object
  }
) => ({
  query: string,
  variables: Object
})

export type BeforeDeploy = (
  key: string,
  {
    mutation: string,
    variables: Object
  }
) => ({
  mutation: string,
  variables: Object
});

export type AfterDeploy = ({
  key: string,
  id: string,
  result: any
}) => void;

export type History ={
  push: (path: string) => void,
  location: Object
};

export type Intl = {
  locale: string,
  defaultLocale: string,
  messages: Object
};

export type HideButtons = boolean;
export type BaseUrl = string;

export type CMSProps = {
  schema: LoadedSchema,
  dataDidChange: DataDidChange,
  afterDeploy: AfterDeploy,
  beforeFetch?: BeforeFetch,
  beforeDeploy?: BeforeDeploy,
  baseUrl: BaseUrl,
  goTo: Object => void,
  routes: Array<string>,
  routerParams: Object,
  intl: Intl,
  hideButtons: HideButtons,
  errorHandler: Error => any,
  defaultKey?: string
}

export type GeneratorProps = {
  componentTree: ComponentTree,
  layouts: {[string]: React.ComponentType<*>},
  imageStorages: Object,
  fileStorages: Object,

  goTo: Object => void,
  baseUrl: string,
  routes: Array<string>,
  routerParams: {[string]: string},
  refresh?: boolean,
  deploy?: Function,
  reset?: Function,
  onDeploy?: Function,
  removeOnDeploy?: Function,
  hideButtons: boolean,
  schema: Object,
  defaultKey?: string
}

export type ProviderProps = {
  schema: CannerSchema,
  dataDidChange: DataDidChange,
  afterDeploy: AfterDeploy,
  beforeFetch?: BeforeFetch,
  beforeDeploy?: BeforeDeploy,
  children: React.Element<*>,
  client: ApolloClient,
  rootKey: string,
  errorHandler: Error => any,
  routes: Array<string>,
  routerParams: Object
};

export type Submenu = {
  title: string,
  items: Sidebar,
}
export type MenuItem = {
  title: string,
  to: string
}

export type Sidebar = ?Array<Submenu | MenuItem>

export type SidebarProps = {
  schema: CannerSchema,
  sidebar: Sidebar,
  goTo: Function,
  dataChanged: Object,
  reset: Function,
  routes: Array<string>
}