graphql-form 0.0.6 → 0.0.9

package/lib/createWidget.d.ts

@@ -1,13 +1,15 @@
-/// <reference types="react" />
 import { PassedFormProps, CastToWidgetSettingsPassedForm } from "./models";
-export declare function createWidget<Props>({ name, Component, Settings, requirements, }: {
+import React from 'react';
+export declare function createWidget<Props>({ name, Component, Settings, Description, requirements, }: {
     name: string;
     Component: React.FC<PassedFormProps<Props>>;
     Settings?: React.FC<CastToWidgetSettingsPassedForm<Props>>;
+    Description?: React.FC;
     requirements: (props: PassedFormProps) => boolean;
 }): {
-    Component: import("react").FC<PassedFormProps<Props>>;
-    Settings: import("react").FC<CastToWidgetSettingsPassedForm<Props>> | undefined;
+    Component: React.FC<PassedFormProps<Props>>;
+    Settings: React.FC<CastToWidgetSettingsPassedForm<Props>> | undefined;
+    Description: React.FC<{}> | undefined;
     requirements: (props: PassedFormProps) => boolean;
     props: Props;
     name: string;

package/lib/createWidget.js

@@ -2,10 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createWidget = void 0;
 function createWidget(_a) {
-    var name = _a.name, Component = _a.Component, Settings = _a.Settings, requirements = _a.requirements;
+    var name = _a.name, Component = _a.Component, Settings = _a.Settings, Description = _a.Description, requirements = _a.requirements;
     return {
         Component: Component,
         Settings: Settings,
+        Description: Description,
         requirements: requirements,
         props: {},
         name: name,

package/lib/createWidget.js.map

@@ -1 +1 @@
-{"version":3,"file":"createWidget.js","sourceRoot":"","sources":["../src/createWidget.tsx"],"names":[],"mappings":";;;AAEA,SAAgB,YAAY,CAAQ,EAUnC;QATG,IAAI,UAAA,EACJ,SAAS,eAAA,EACT,QAAQ,cAAA,EACR,YAAY,kBAAA;IAOZ,OAAO;QACH,SAAS,WAAA;QACT,QAAQ,UAAA;QACR,YAAY,cAAA;QACZ,KAAK,EAAE,EAAW;QAClB,IAAI,MAAA;KACP,CAAC;AACN,CAAC;AAlBD,oCAkBC"}
+{"version":3,"file":"createWidget.js","sourceRoot":"","sources":["../src/createWidget.tsx"],"names":[],"mappings":";;;AAGA,SAAgB,YAAY,CAAQ,EAYnC;QAXG,IAAI,UAAA,EACJ,SAAS,eAAA,EACT,QAAQ,cAAA,EACR,WAAW,iBAAA,EACX,YAAY,kBAAA;IAQZ,OAAO;QACH,SAAS,WAAA;QACT,QAAQ,UAAA;QACR,WAAW,aAAA;QACX,YAAY,cAAA;QACZ,KAAK,EAAE,EAAW;QAClB,IAAI,MAAA;KACP,CAAC;AACN,CAAC;AArBD,oCAqBC"}

package/lib/models.d.ts

@@ -7,7 +7,7 @@ export declare type FormLabelProps = React.FC<PassedFormProps & {
 }>;
 export declare type WidgetSavedData = {
     widget: string;
-    [x: string]: any;
+    [x: string]: unknown;
 };
 export declare type SavedWidgets = {
     [selector: string]: WidgetSavedData | undefined;
@@ -15,14 +15,15 @@ export declare type SavedWidgets = {
 export declare type SavedForms = {
     [selector: string]: FormObject;
 };
-export declare type PassedFormProps<WidgetData = any> = {
+export declare type ReturnedDictType = Record<string, unknown> | undefined;
+export declare type PassedFormProps<WidgetData = ReturnedDictType> = {
     f: ParserField;
     nodes: ParserField[];
     formObject: FormObject;
     onChange: (formObject: FormObject) => void;
     changeWidget: (widgetData: WidgetSavedData | undefined, path: string) => void;
     required?: boolean;
-    runQuery: (q: string) => Promise<any>;
+    runQuery: (q: string) => Promise<ReturnedDictType>;
     widgetComponents: WidgetType[];
     currentPath: string;
     widgets?: SavedWidgets;
@@ -52,14 +53,14 @@ export declare type FormDisplayerProps = Omit<PassedFormProps, 'formObject' | 'o
     onChange: (o: FormFile, query: string) => void;
 };
 export declare type FormLibraryProps = Omit<FormDisplayerProps, 'required' | 'components'>;
-export declare type CastToWidgetSettingsPassedForm<WidgetData> = PassedFormProps<Partial<WidgetData>> & {
-    close: () => void;
+export declare type CastToWidgetSettingsPassedForm<WidgetData = ReturnedDictType> = PassedFormProps<Partial<WidgetData>> & {
+    widgetSettingsChange: (data: WidgetData) => void;
 };
 export declare type WidgetType = {
     Component: React.FC<PassedFormProps>;
-    Settings: React.FC<CastToWidgetSettingsPassedForm<any>> | undefined;
+    Settings: React.FC<CastToWidgetSettingsPassedForm> | undefined;
     requirements: (props: PassedFormProps) => boolean;
-    props?: Record<string, any>;
+    props?: ReturnedDictType;
     name: string;
 };
 export declare type FormValue = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "graphql-form",
-    "version": "0.0.6",
+    "version": "0.0.9",
     "description": "Easy form creation with GraphQL Editor and React",
     "main": "lib/index.js",
     "scripts": {

package/src/createWidget.tsx

@@ -1,19 +1,23 @@
 import { PassedFormProps, CastToWidgetSettingsPassedForm } from '@/models';
+import React from 'react';
 
 export function createWidget<Props>({
     name,
     Component,
     Settings,
+    Description,
     requirements,
 }: {
     name: string;
     Component: React.FC<PassedFormProps<Props>>;
     Settings?: React.FC<CastToWidgetSettingsPassedForm<Props>>;
+    Description?: React.FC;
     requirements: (props: PassedFormProps) => boolean;
 }) {
     return {
         Component,
         Settings,
+        Description,
         requirements,
         props: {} as Props,
         name,

package/src/models.ts

@@ -7,7 +7,7 @@ export type FormLabelProps = React.FC<PassedFormProps & { open?: boolean; setOpe
 
 export type WidgetSavedData = {
     widget: string;
-    [x: string]: any;
+    [x: string]: unknown;
 };
 
 export type SavedWidgets = {
@@ -17,14 +17,16 @@ export type SavedForms = {
     [selector: string]: FormObject;
 };
 
-export type PassedFormProps<WidgetData = any> = {
+export type ReturnedDictType = Record<string, unknown> | undefined;
+
+export type PassedFormProps<WidgetData = ReturnedDictType> = {
     f: ParserField;
     nodes: ParserField[];
     formObject: FormObject;
     onChange: (formObject: FormObject) => void;
     changeWidget: (widgetData: WidgetSavedData | undefined, path: string) => void;
     required?: boolean;
-    runQuery: (q: string) => Promise<any>;
+    runQuery: (q: string) => Promise<ReturnedDictType>;
     widgetComponents: WidgetType[];
     currentPath: string;
     widgets?: SavedWidgets;
@@ -64,15 +66,15 @@ export type FormDisplayerProps = Omit<
 
 export type FormLibraryProps = Omit<FormDisplayerProps, 'required' | 'components'>;
 
-export type CastToWidgetSettingsPassedForm<WidgetData> = PassedFormProps<Partial<WidgetData>> & {
-    close: () => void;
+export type CastToWidgetSettingsPassedForm<WidgetData = ReturnedDictType> = PassedFormProps<Partial<WidgetData>> & {
+    widgetSettingsChange: (data: WidgetData) => void;
 };
 
 export type WidgetType = {
     Component: React.FC<PassedFormProps>;
-    Settings: React.FC<CastToWidgetSettingsPassedForm<any>> | undefined;
+    Settings: React.FC<CastToWidgetSettingsPassedForm> | undefined;
     requirements: (props: PassedFormProps) => boolean;
-    props?: Record<string, any>;
+    props?: ReturnedDictType;
     name: string;
 };