@gravitywiz/types 0.0.1 → 0.0.2

package/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_size = 4

package/README.md

@@ -28,5 +28,5 @@ To use the ambient module definitions to make types available on the `window` ob
 This also supports importing individual types like so:
 
 ```ts
-import type { Field } from 'types-gravity-wiz/gravityforms';
+import type { GFField } from 'types-gravity-wiz/gravityforms';
 ```

package/gravityforms.d.ts

@@ -1,43 +1,67 @@
 /**
  * Type definitions for Gravity Forms.
  */
+declare global {
+	type GFFieldID = number | string;
+	type GFFormID = number | string;
 
-export interface Form {
-}
+	interface GFField {
+		inputs: any;
+		choices: GFChoice[];
+		label: string;
+		adminLabel?: string;
+		id: number;
+		formId: number;
+		type: string;
+		enableEnhancedUI?: boolean;
+		inputType: string;
+	}
 
-export interface Field {
-    id: number
-    formId: number
-    type: string
-    enableEnhancedUI: boolean
-    choices: MultiSelectChoice[]
-}
+	interface GFChoice {
+		isSelected?: boolean;
+		price?: string;
+		text: string;
+		value: string;
+	}
 
-export interface MultiSelectChoice {
-    isSelected: boolean;
-    price: string;
-    text: string;
-    value: string;
-}
+	interface GFForm {
+		button: {
+			type: string;
+			text: string;
+			imageUrl: string;
+		};
+		confirmations: any;
+		description: string;
+		descriptionPlacement: string;
+		fields: GFField[];
+		firstPageCssClass: string;
+		id: number;
+		labelPlacement: string;
+		lastPageButton: string;
+		markupVersion: number;
+		nextFieldId: number;
+		notifications: any;
+		pagination: any;
+		postContentTemplate: string;
+		postContentTemplateEnabled: boolean;
+		postTitleTemplate: string;
+		postTitleTemplateEnabled: boolean;
+		title: string;
+		useCurrentUserAsAuthor: boolean;
+		version: string;
+		[key: string]: any;
+	}
 
-// TODO type ...any better (e.g. provide a way to for the caller to declare what these arguments should be).
-export type HookCallback = (...args: any[]) => void
+	interface GFConditionalLogicRuleField {
+		label: string;
+		value: string | number;
+	}
 
-declare global {
-    interface Window {
-        jQuery: JQueryStatic
-        gform: {
-            addAction: (actionName: string, cb: HookCallback, priority?: number, tag?: string) => void;
-            addFilter: (filterName: string, cb: HookCallback, priority?: number, tag?: string) => void;
-            doAction: (actionName: string, ...any) => void;
-            applyFilters: (filterName: string, ...any) => any;
-            removeAction: (actionName: string, tag?:string) => void;
-            removeFilter: (actionName: string, priority?: number, tag?: string) => void;
-        }
-        field: Field
-        form: Form
-        UpdateFieldChoices: (fieldType: string) => void
-        SetFieldProperty: (setting: string, value: any) => void
-        SetFieldEnhancedUI: (enabled: boolean) => void
-    }
-}
+	interface GFConditionalLogicRule {
+		fieldId: string;
+		operator: string;
+		value: number | string;
+	}
+}
+
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravitywiz/types",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "TypesScript type definitions for Gravity Forms and Gravity Wiz.",
   "main": "index.d.ts",
   "type": "module",
@@ -8,6 +8,7 @@
   "license": "MIT",
   "private": false,
   "devDependencies": {
-    "@types/jquery": "^3.5.16"
+    "@types/jquery": "^3.5.16",
+    "@types/plupload": "^2.0.10"
   }
 }

package/window.d.ts

@@ -0,0 +1,104 @@
+import * as Plupload from "plupload";
+
+// TODO type ...any better (e.g. provide a way to for the caller to declare what these arguments should be).
+export type HookCallback = (...args: any[]) => void;
+
+declare global {
+	interface Window {
+		jQuery: JQueryStatic;
+
+		// Form Editor
+		field: GFField;
+		fieldSettings: { [fieldType: string]: string };
+		form: GFForm;
+		UpdateFieldChoices: (fieldType: string) => void;
+		SetFieldProperty: (setting: string, value: any) => void;
+		SetFieldEnhancedUI: (enabled: boolean) => void;
+		GetSelectedField: () => GFField;
+		GetFieldById: (fieldId: GFFieldID) => GFField;
+		GetLabel: (
+			field: GFField,
+			inputId?: number,
+			inputOnly?: boolean
+		) => string;
+		has_entry: (fieldId: GFFieldID) => boolean;
+		IsPricingField: (fieldType: string) => boolean;
+		IsProductField: (fieldType: string) => boolean;
+		HasPageField: () => boolean;
+		HasPostField: () => boolean;
+		ToggleMultiFile: (isInit: boolean) => void;
+		GetInputType: (field: GFField) => string;
+		SetFieldPhoneFormat: (format: string) => void;
+
+		// Frontend
+		gform: {
+			addAction: (
+				actionName: string,
+				cb: HookCallback,
+				priority?: number,
+				tag?: string
+			) => void;
+			removeAction: (actionName: string, tag?: string) => void;
+			addFilter: (
+				filterName: string,
+				cb: HookCallback,
+				priority?: number,
+				tag?: string
+			) => void;
+			removeFilter: (
+				filterName: string,
+				priority?: number,
+				tag?: string
+			) => void;
+			doAction: (actionName: string, ...args: any[]) => void;
+			applyFilters: <S>(
+				filterName: string,
+				subject: S,
+				...args: any[]
+			) => S;
+		};
+
+		gformCalculateTotalPrice: (formId: string | number) => void;
+
+		gfMultiFileUploader: {
+			uploaders: { [name: string]: Plupload.Uploader };
+			setup: Function;
+			toggleDisabled: Function;
+		};
+
+		gformDeleteUploadedFile: (
+			formId: string,
+			fieldId: string,
+			deleteButton: HTMLElement
+		) => void;
+
+		mOxie: any;
+
+		// Placeholders
+		gfMergeTagsObj: any;
+		gf_raw_input_change: any;
+		gf_check_field_rule: any;
+		gf_global: any;
+		gf_vars: any;
+		gformInitChosenFields: any;
+		ToggleCalculationOptions: any;
+		gformInitDatepicker: any;
+		GFCalc: any;
+		GFMergeTag: any;
+		gfAjaxSpinner: any;
+		gformIsHidden: any;
+		gf_form_conditional_logic: any;
+		Currency: any;
+		gf_matches_operation: any;
+		gf_apply_rules: any;
+	}
+
+	interface String {
+		// Deprecated, being removed in GF 2.8.
+		format: (...format: any[]) => string;
+
+		gformFormat: (...format: any[]) => string;
+	}
+}
+
+export {};