wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

Author: crynobone

package.json

@@ -1,7 +1,7 @@
 {
   "name": "laravel-nova-devtool",
   "description": "Laravel Nova DevTool",
-  "types": "types/index.d.ts",
+  "types": "types/nova.d.ts",
   "devDependencies": {
     "@inertiajs/vue3": "^1.0.0",
     "axios": "^1.7.4",

types/form.d.ts

@@ -0,0 +1,66 @@
+import type { AxiosInstance, AxiosResponse } from 'axios'
+
+export type FormData = {
+  [key: string]: any;
+}
+
+type FormOptions = {
+  http?: AxiosInstance;
+  resetOnSuccess?: boolean;
+  onSuccess?: Function;
+  onFail?: Function;
+}
+
+export declare type Form = {
+  create: (data?: FormData) => Form;
+
+  processing: boolean;
+  successful: boolean;
+  errors: Errors;
+  __http: AxiosInstance;
+
+  delete: (url: string) => Promise<any>;
+  patch: (url: string) => Promise<any>;
+  post: (url: string) => Promise<any>;
+  put: (url: string) => Promise<any>;
+  submit: (requestType: string, url: string) => Promise<any>;
+
+  getError: (field: string) => string | null;
+  getErrors: (field: string) => string[];
+
+  hasError: (field: string) => boolean;
+  hasFiles(): () => boolean;
+  hasFilesDeep: (object: any | any[]) => boolean;
+
+  clear: () => void;
+  data: () => FormData;
+  only: (fields: any[]) => FormData;
+  populate: (data: FormData) => Form;
+  reset: () => void;
+  setInitialValues: (values: FormData) => void;
+
+  onFail: (error: AxiosResponse) => void;
+  onSuccess: (data: any) => void;
+
+  withData: (data: FormData) => Form;
+  withErrors: (errors: ErrorCollection) => Form;
+  withOptions: (options: FormOptions) => Form;
+
+  [key: string]: any;
+}
+
+export type ErrorCollection = {
+  [key: string]: string[];
+}
+
+export declare type Errors = {
+  errors: ErrorCollection;
+
+  all: () => ErrorCollection;
+  any: (keys?: string[]) => ErrorCollection;
+  clear: (field: string | null) => void;
+  first: (field: string) => string | null;
+  get: (field: string) => string[];
+  has: (field: string) => boolean;
+  record: (errors?: ErrorCollection) => void;
+}

types/index.d.ts

@@ -0,0 +1,133 @@
+import type { 
+  App as VueApp,
+  Component as VueComponent 
+} from 'vue'
+import type { Router } from '@inertiajs/core'
+import type { AxiosInstance } from 'axios'
+import type { Store } from 'vuex'
+import type { Form } from './form'
+import type { Menu } from './menu'
+
+type State = {
+  baseUri: string;
+  currentUser: any;
+  mainMenu: any[];
+  userMenu: any[];
+  resources: any[];
+  version: string;
+  mainMenuShown: boolean;
+  canLeaveForm: boolean;
+  canLeaveModal: boolean;
+  pushStateWasTriggered: boolean;
+  validLicense: true;
+  [key: string]: any;
+}
+
+type BootingCallback = ((app: VueApp, store: Store<State>) => void);
+
+type Color = {
+  [key: string]: string;
+}
+
+export type AppConfig = {
+  algoliaApiKey?: any;
+  algoliaAppId?: any;
+  appName: string;
+  base: string;
+  brandColors: Color[];
+  brandColorsCSS: string;
+  customLoginPath: boolean;
+  customLogoutPath: boolean;
+  debounce: number;
+  footer: string;
+  forgotPasswordPath: string | boolean;
+  globalSearchEnabled: boolean;
+  hasGloballySearchableResources: boolean;
+  initialPath: string;
+  locale: string;
+  logo?: string;
+  mainMenu: Menu[];
+  notificationCenterEnabled: boolean;
+  notificationPollingInterval: number;
+  pagination: string;
+  resetPasswordPath: boolean;
+  resources: Resource[];
+  rtlEnabled: boolean;
+  themeSwitcherEnabled: boolean;
+  timezone: string;
+  translations: Translations;
+  userId: number;
+  userMenu: Menu[];
+  userTimezone?: any;
+  version: string;
+  withAuthentication: boolean;
+  withPasswordReset: boolean;
+  [key: string]: any;
+}
+
+type Resource = {
+  uriKey: string;
+  label: string;
+  singularLabel: string;
+  createButtonLabel: string;
+  updateButtonLabel: string;
+  authorizedToCreate: boolean;
+  searchable: boolean;
+  perPageOptions: number[];
+  tableStyle: string;
+  showColumnBorders: boolean;
+  debounce: number;
+  clickAction: string;
+};
+
+type Translations = {
+  [key: string]: string;
+}
+
+export declare type NovaApp = {
+  pages: {[key: string]: VueComponent | string};
+  $router: Router;
+  readonly appConfig: AppConfig;
+  store: Store<State>;
+  
+  boot: () => void;
+  booting: (callback: BootingCallback) => void;
+  booted: (callback: BootingCallback) => void;
+  config: (key: string) => any;
+  countdown(): Promise<void>;
+  form: (data: {[key: string]: any}) => Form;
+  hasSecurityFeatures(): boolean;
+  liftOff: () => void;
+  missingResource: (uriKey: string) => boolean;
+  redirectToLogin: () => void;
+  url: (path: string, parameters: any) => string;
+
+  request: (options: Object) => AxiosInstance;
+
+  inertia: (name: string, component: VueComponent | string) => void;
+  visit: (path: ({ url: string; remote: boolean; } | string), options?: Object) => void;
+
+  component: (name: string, component: VueComponent | string) => void;
+  hasComponent: (name: string) => boolean;
+
+  debug: (message: any, type?: string) => void;
+  log: (message: string, type?: string) => void;
+
+  error: (message: string) => void;
+  info: (message: string) => void;
+  success: (message: string) => void;
+  warning: (message: string) => void;
+
+  formatNumber: (number: number, format: any | string) => string;
+
+  $emit: (event: string, ...args: any[]) => void;
+  $on: (event: string, callback: Function, ctx?: any) => void;
+  $once: (event: string, callback: Function, ctx?: any) => void;
+  $off: (event: string, callback?: Function) => void;
+}
+
+declare global {
+  interface Window {
+    Nova: NovaApp;
+  }
+}