@gravitywiz/types 0.0.2 → 0.0.3

package/README.md

@@ -2,9 +2,7 @@
 
 Herein find TypeScript definitions for Gravity Forms, Perks crafted by Gravity Wiz and other Gravity Forms plugins.
 
-# 🚀 Usage
-
-### Install
+## 💾 Installation
 
 ```sh
 yarn add -D types-gravity-wiz
@@ -15,18 +13,32 @@ or...
 npm install --save-dev types-gravity-wiz
 ```
 
-### Extending `window`
+## 🚀 Usage
 
-To use the ambient module definitions to make types available on the `window` object, reference the respective types files you need like this. (Make sure to the path is correct for your setup.)
+### `tsconfig.json`
 
-```ts
-/// <reference path="../../../node_modules/types-gravity-wiz/gravityforms.d.ts" />
+To make ambient types automatically available, you can add `@gravitywiz` to the TypeScript `typeRoots` like so:
+
+(By default, `node_modules/@types` is included in `typeRoots` and it's recommended to keep it.)
+
+```json
+{
+	"compilerOptions": {
+		"typeRoots": [
+			"node_modules/@types",
+			"node_modules/@gravitywiz"
+		]
+	}
+}
 ```
 
-### Importing types individually
+### `/// <reference path="..." />`
+
+To use the ambient module definitions without modifying `tsconfig.json`, you can load in the types using
+[`/// <reference path="..." />`](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html#-reference-path-).
 
-This also supports importing individual types like so:
+(Make sure to the path is correct for your setup.)
 
 ```ts
-import type { GFField } from 'types-gravity-wiz/gravityforms';
+/// <reference path="../../../node_modules/@gravitywiz/types/index.d.ts" />
 ```

package/index.d.ts

@@ -1,6 +1,165 @@
-export {};
+import * as Plupload from "plupload";
 
 declare global {
-    interface Window {
-    }
+	type GFFieldID = number | string;
+	type GFFormID = number | string;
+
+	// TODO type ...any better (e.g. provide a way to for the caller to declare what these arguments should be).
+	type GFHookCallback = (...args: any[]) => void;
+
+	interface GFField {
+		inputs: any;
+		choices: GFChoice[];
+		label: string;
+		adminLabel?: string;
+		id: number;
+		formId: number;
+		type: string;
+		enableEnhancedUI?: boolean;
+		inputType: string;
+	}
+
+	interface GFChoice {
+		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;
+	}
+
+	interface GFConditionalLogicRuleField {
+		label: string;
+		value: string | number;
+	}
+
+	interface GFConditionalLogicRule {
+		fieldId: string;
+		operator: string;
+		value: number | string;
+	}
+
+	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: GFHookCallback,
+				priority?: number,
+				tag?: string
+			) => void;
+			removeAction: (actionName: string, tag?: string) => void;
+			addFilter: (
+				filterName: string,
+				cb: GFHookCallback,
+				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 {};

package/package.json

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

package/gravityforms.d.ts

@@ -1,67 +0,0 @@
-/**
- * Type definitions for Gravity Forms.
- */
-declare global {
-	type GFFieldID = number | string;
-	type GFFormID = number | string;
-
-	interface GFField {
-		inputs: any;
-		choices: GFChoice[];
-		label: string;
-		adminLabel?: string;
-		id: number;
-		formId: number;
-		type: string;
-		enableEnhancedUI?: boolean;
-		inputType: string;
-	}
-
-	interface GFChoice {
-		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;
-	}
-
-	interface GFConditionalLogicRuleField {
-		label: string;
-		value: string | number;
-	}
-
-	interface GFConditionalLogicRule {
-		fieldId: string;
-		operator: string;
-		value: number | string;
-	}
-}
-
-export {};

package/window.d.ts

@@ -1,104 +0,0 @@
-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 {};