@bpmn-io/form-js-viewer - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

dist/index.es.js

@@ -1638,21 +1638,12 @@ import { isArray, isFunction, isNumber, bind, assign, get, set, isString } from 'min-dash';
 /**
- * @typedef { import('didi').Injector } Injector
+ * @typedef { import('./types').Injector } Injector
+ * @typedef { import('./types').Data } Data
+ * @typedef { import('./types').Errors } Errors
+ * @typedef { import('./types').Schema } Schema
+ * @typedef { import('./types').FormProperties } FormProperties
+ * @typedef { import('./types').FormProperty } FormProperty
+ * @typedef { import('./types').FormEvent } FormEvent
+ * @typedef { import('./types').FormOptions } FormOptions
  *
- * @typedef { { [x: string]: any } } Data
- * @typedef { { [x: string]: string[] } } Errors
- * @typedef { any[] } Modules
- * @typedef { ('readOnly' | string) } FormProperty
- * @typedef { ('submit' | 'changed' | string) } FormEvent
- * @typedef { { [x: string]: any } } FormProperties
- * @typedef { any } Schema
- *
  * @typedef { {
- *   additionalModules?: Modules,
- *   container?: Element|string,
- *   injector?: Injector,
- *   modules?: Modules,
- *   properties?: FormProperties
- * } } FormOptions
- *
- * @typedef { {
  *   data: Data,
@@ -1666,2 +1657,6 @@ *   initialData: Data,
 
+/**
+ * The form.
+ */
+
 class Form {
@@ -2027,18 +2022,3 @@ /**
 /**
- * @typedef { import('didi').Injector } Injector
- *
- * @typedef { { [x: string]: any } } Data
- * @typedef { any } Schema
- * @typedef { any[] } Modules
- * @typedef { { [x: string]: any } } FormPropertyOptions
- *
- * @typedef { {
- *   additionalModules?: Modules,
- *   container?: Element|string,
- *   data?: Data,
- *   injector?: Injector,
- *   modules?: Modules,
- *   properties?: FormPropertyOptions,
- *   schema: Schema
- * } } FormViewerOptions
+ * @typedef { import('./types').CreateFormOptions } CreateFormOptions
  */
@@ -2049,3 +2029,3 @@
  *
- * @param {FormViewerOptions} options
+ * @param {CreateFormOptions} options
  *
@@ -2052,0 +2032,0 @@ * @return {Promise<Form>}

dist/types/core/EventBus.d.ts

 export {};

dist/types/core/FormFieldRegistry.d.ts

 declare const Map: MapConstructor;
 export default Map;

dist/types/core/index.d.ts

@@ -0,0 +0,0 @@ declare namespace _default {

dist/types/core/Validator.d.ts

 export default class Validator {
     validateField(field: any, value: any): any[];
 }

dist/types/Form.d.ts

 /**
- * @typedef { import('didi').Injector } Injector
+ * @typedef { import('./types').Injector } Injector
+ * @typedef { import('./types').Data } Data
+ * @typedef { import('./types').Errors } Errors
+ * @typedef { import('./types').Schema } Schema
+ * @typedef { import('./types').FormProperties } FormProperties
+ * @typedef { import('./types').FormProperty } FormProperty
+ * @typedef { import('./types').FormEvent } FormEvent
+ * @typedef { import('./types').FormOptions } FormOptions
  *
- * @typedef { { [x: string]: any } } Data
- * @typedef { { [x: string]: string[] } } Errors
- * @typedef { any[] } Modules
- * @typedef { ('readOnly' | string) } FormProperty
- * @typedef { ('submit' | 'changed' | string) } FormEvent
- * @typedef { { [x: string]: any } } FormProperties
- * @typedef { any } Schema
- *
  * @typedef { {
- *   additionalModules?: Modules,
- *   container?: Element|string,
- *   injector?: Injector,
- *   modules?: Modules,
- *   properties?: FormProperties
- * } } FormOptions
- *
- * @typedef { {
  *   data: Data,
@@ -28,2 +19,5 @@ *   initialData: Data,
  */
+/**
+ * The form.
+ */
 export default class Form {
@@ -137,22 +131,9 @@ /**
 export type Injector = any;
-export type Data = {
-    [x: string]: any;
-};
-export type Errors = {
-    [x: string]: string[];
-};
-export type Modules = any[];
-export type FormProperty = ('readOnly' | string);
-export type FormEvent = ('submit' | 'changed' | string);
-export type FormProperties = {
-    [x: string]: any;
-};
-export type Schema = any;
-export type FormOptions = {
-    additionalModules?: any[];
-    container?: Element | string;
-    injector?: Injector;
-    modules?: Modules;
-    properties?: FormProperties;
-};
+export type Data = import('./types').Data;
+export type Errors = import('./types').Errors;
+export type Schema = import('./types').Schema;
+export type FormProperties = import('./types').FormProperties;
+export type FormProperty = import('./types').FormProperty;
+export type FormEvent = import('./types').FormEvent;
+export type FormOptions = import('./types').FormOptions;
 export type State = {
@@ -159,0 +140,0 @@ data: Data;

dist/types/import/Importer.d.ts

@@ -0,0 +0,0 @@ declare class Importer {

dist/types/import/index.d.ts

@@ -0,0 +0,0 @@ declare namespace _default {

dist/types/index.d.ts

 /**
- * @typedef { import('didi').Injector } Injector
- *
- * @typedef { { [x: string]: any } } Data
- * @typedef { any } Schema
- * @typedef { any[] } Modules
- * @typedef { { [x: string]: any } } FormPropertyOptions
- *
- * @typedef { {
- *   additionalModules?: Modules,
- *   container?: Element|string,
- *   data?: Data,
- *   injector?: Injector,
- *   modules?: Modules,
- *   properties?: FormPropertyOptions,
- *   schema: Schema
- * } } FormViewerOptions
+ * @typedef { import('./types').CreateFormOptions } CreateFormOptions
  */
@@ -22,29 +7,12 @@ /**
  *
- * @param {FormViewerOptions} options
+ * @param {CreateFormOptions} options
  *
  * @return {Promise<Form>}
  */
-export function createForm(options: FormViewerOptions): Promise<Form>;
+export function createForm(options: CreateFormOptions): Promise<Form>;
 export * from "./render";
 export * from "./util";
-export type Injector = any;
-export type Data = {
-    [x: string]: any;
-};
-export type Schema = any;
-export type Modules = any[];
-export type FormPropertyOptions = {
-    [x: string]: any;
-};
-export type FormViewerOptions = {
-    additionalModules?: any[];
-    container?: Element | string;
-    data?: Data;
-    injector?: Injector;
-    modules?: Modules;
-    properties?: FormPropertyOptions;
-    schema: Schema;
-};
+export type CreateFormOptions = import('./types').CreateFormOptions;
 import Form from "./Form";
 export const schemaVersion: 2;
 export { Form };

dist/types/render/components/Description.d.ts

 export default function Description(props: any): import("preact").JSX.Element;

dist/types/render/components/Errors.d.ts

 export default function Errors(props: any): import("preact").JSX.Element;

dist/types/render/components/form-fields/Button.d.ts

@@ -0,0 +0,0 @@ declare function Button(props: any): import("preact").JSX.Element;

dist/types/render/components/form-fields/Checkbox.d.ts

@@ -0,0 +0,0 @@ declare function Checkbox(props: any): import("preact").JSX.Element;

dist/types/render/components/form-fields/Default.d.ts

@@ -0,0 +0,0 @@ declare function Default(props: any): import("preact").JSX.Element;

dist/types/render/components/form-fields/Number.d.ts

@@ -0,0 +0,0 @@ declare function Number(props: any): import("preact").JSX.Element;

dist/types/render/components/form-fields/Radio.d.ts

@@ -0,0 +0,0 @@ declare function Radio(props: any): import("preact").JSX.Element;

dist/types/render/components/form-fields/Select.d.ts

@@ -0,0 +0,0 @@ declare function Select(props: any): import("preact").JSX.Element;

dist/types/render/components/form-fields/Text.d.ts

@@ -0,0 +0,0 @@ declare function Text(props: any): import("preact").JSX.Element;

dist/types/render/components/form-fields/Textfield.d.ts

@@ -0,0 +0,0 @@ declare function Textfield(props: any): import("preact").JSX.Element;

dist/types/render/components/FormComponent.d.ts

 export default function FormComponent(props: any): import("preact").JSX.Element;

dist/types/render/components/FormField.d.ts

 export default function FormField(props: any): import("preact").JSX.Element;

dist/types/render/components/index.d.ts

@@ -0,0 +0,0 @@ export const formFields: (typeof Checkbox | typeof Default | typeof Text)[];

dist/types/render/components/Label.d.ts

 export default function Label(props: any): import("preact").JSX.Element;

dist/types/render/components/PoweredBy.d.ts

 export default function PoweredBy(props: any): import("preact").JSX.Element;

dist/types/render/components/Sanitizer.d.ts

@@ -0,0 +0,0 @@ /**

dist/types/render/components/Util.d.ts

@@ -0,0 +0,0 @@ export function formFieldClasses(type: any, errors?: any[]): string;

dist/types/render/context/FormContext.d.ts

@@ -0,0 +0,0 @@ export default FormContext;

dist/types/render/context/FormRenderContext.d.ts

@@ -0,0 +0,0 @@ export default FormRenderContext;

dist/types/render/context/index.d.ts

 export { default as FormRenderContext } from "./FormRenderContext";
 export { default as FormContext } from "./FormContext";

dist/types/render/FormFields.d.ts

@@ -0,0 +0,0 @@ export default class FormFields {

dist/types/render/hooks/useService.d.ts

 export default function _default(type: any, strict: any): any;

dist/types/render/index.d.ts

@@ -0,0 +0,0 @@ export { FormFields };

dist/types/render/Renderer.d.ts

@@ -0,0 +0,0 @@ /**

dist/types/util/form.d.ts

@@ -0,0 +0,0 @@ /**

dist/types/util/index.d.ts

@@ -0,0 +0,0 @@ export function findErrors(errors: any, path: any): any;

dist/types/util/injector.d.ts

 export function createInjector(bootstrapModules: any): any;

package.json

 {
   "name": "@bpmn-io/form-js-viewer",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "View forms - powered by bpmn.io",
@@ -26,3 +26,3 @@ "exports": {
     "dev": "npm test -- --auto-watch --no-single-run",
-    "generate-types": "tsc --allowJs --skipLibCheck --declaration --emitDeclarationOnly --outDir dist/types src/index.js",
+    "generate-types": "tsc --allowJs --skipLibCheck --declaration --emitDeclarationOnly --outDir dist/types src/index.js && cp src/*.d.ts dist/types",
     "test": "karma start",
@@ -54,3 +54,3 @@ "prepublishOnly": "npm run build"
   ],
-  "gitHead": "d843d0668e69e09cad1220e9dd25a0e1cbcc1461"
+  "gitHead": "702e55edc23b70571ba1e3efd6372e160f5f33cd"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of package files

44

increased by2.33%

Worsened metrics

Total package byte prevSize

308219

decreased by-0.69%

Lines of code

4146

decreased by-1.57%

No dependency changes