@gravitywiz/types 0.0.1

package/README.md

@@ -0,0 +1,32 @@
+# 🧙‍♂️ Hi! Welcome to Gravity Wiz's Typescript Definitions.
+
+Herein find TypeScript definitions for Gravity Forms, Perks crafted by Gravity Wiz and other Gravity Forms plugins.
+
+# 🚀 Usage
+
+### Install
+
+```sh
+yarn add -D types-gravity-wiz
+```
+
+or...
+```sh
+npm install --save-dev types-gravity-wiz
+```
+
+### Extending `window`
+
+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.)
+
+```ts
+/// <reference path="../../../node_modules/types-gravity-wiz/gravityforms.d.ts" />
+```
+
+### Importing types individually
+
+This also supports importing individual types like so:
+
+```ts
+import type { Field } from 'types-gravity-wiz/gravityforms';
+```

package/gravityforms.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Type definitions for Gravity Forms.
+ */
+
+export interface Form {
+}
+
+export interface Field {
+    id: number
+    formId: number
+    type: string
+    enableEnhancedUI: boolean
+    choices: MultiSelectChoice[]
+}
+
+export interface MultiSelectChoice {
+    isSelected: boolean;
+    price: string;
+    text: string;
+    value: string;
+}
+
+// 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
+        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
+    }
+}

package/index.d.ts

@@ -0,0 +1,6 @@
+export {};
+
+declare global {
+    interface Window {
+    }
+}

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@gravitywiz/types",
+  "version": "0.0.1",
+  "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"
+  }
+}