@genesislcap/foundation-forms 14.12.0 → 14.12.1-web-types.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/dts/filters/filters.d.ts +6 -0
  2. package/dist/dts/filters/filters.d.ts.map +1 -1
  3. package/dist/dts/form.d.ts +9 -1
  4. package/dist/dts/form.d.ts.map +1 -1
  5. package/dist/esm/filters/filters.js +2 -0
  6. package/dist/esm/form.js +3 -0
  7. package/docs/api-report.md +1 -6
  8. package/package.json +20 -8
  9. package/vscode.html-custom-data.json +68 -0
  10. package/web-types.json +193 -0
  11. package/dist/dts/tsdoc-metadata.json +0 -11
  12. package/dist/foundation-forms.api.json +0 -1099
  13. package/dist/foundation-forms.d.ts +0 -298
package/dist/dts/filters/filters.d.ts CHANGED
@@ -10,12 +10,14 @@ export declare const filtersRenderers: any[];
10
10
  * Foundation filters component for automatically generated filters based on json schema
11
11
  * obtained from the api, supplied initial data or supplied JSON schema.
12
12
  * Allowing customisable filters elements using UI schema and set of custom renderers
13
+ * @element foundation-filters
13
14
  * @beta
14
15
  */
15
16
  export declare class Filters extends FoundationElement {
16
17
  /**
17
18
  * Name of the backend resource which will provide metadata
18
19
  * used to generate filters
20
+ * @attr
19
21
  * @public
20
22
  */
21
23
  resourceName: string;
@@ -57,16 +59,19 @@ export declare class Filters extends FoundationElement {
57
59
  * ],
58
60
  * };
59
61
  * ```
62
+ * @attr :uischema
60
63
  * @public
61
64
  */
62
65
  uischema: UISchemaElement;
63
66
  /**
64
67
  * Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs
68
+ * @attr :renderers
65
69
  * @public
66
70
  */
67
71
  renderers: RendererEntry[];
68
72
  /**
69
73
  * Alternatively to providing {@link Form.resourceName} you can hardcode the JSON schema on the client.
74
+ * @attr :jsonschema
70
75
  * @public
71
76
  * @remarks
72
77
  * Use this when you want to avoid fetching metadata from the server but
@@ -81,6 +86,7 @@ export declare class Filters extends FoundationElement {
81
86
  data: any;
82
87
  /**
83
88
  * Created criteria based on the given data that can be used to filter the data
89
+ * @attr :value
84
90
  * @public
85
91
  */
86
92
  value: string;
package/dist/dts/filters/filters.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/filters/filters.ts"],"names":[],"mappings":"AAGA,OAAO,EAKL,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAY1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAKzC,gBAAgB;AAChB,eAAO,MAAM,aAAa,gDAAqC,CAAC;AAchE,cAAc;AACd,eAAO,MAAM,gBAAgB,OAY5B,CAAC;AACF;;;;;GAKG;AAEH,qBAKa,OAAQ,SAAQ,iBAAiB;IAC5C;;;;OAIG;IACG,YAAY,EAAE,MAAM,CAAC;YACb,mBAAmB;IAW1B,gBAAgB;IAKvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACS,QAAQ,EAAE,eAAe,CAAC;IACtC;;;OAGG;IACS,SAAS,EAAE,aAAa,EAAE,CAAoB;IAC1D;;;;;;OAMG;IACS,UAAU,EAAE,WAAW,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAW;IACnC;;;OAGG;IACS,IAAI,EAAE,GAAG,CAAM;IAC3B;;;OAGG;IACS,KAAK,EAAE,MAAM,CAAC;IAC1B,YAAY;IAIZ;;OAEG;IACH,aAAa;IAuBb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW;IAO3B,oBAAoB;CAKrB"}
1
+ {"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/filters/filters.ts"],"names":[],"mappings":"AAGA,OAAO,EAKL,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAY1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAKzC,gBAAgB;AAChB,eAAO,MAAM,aAAa,gDAAqC,CAAC;AAchE,cAAc;AACd,eAAO,MAAM,gBAAgB,OAY5B,CAAC;AACF;;;;;;GAMG;AACH,qBAKa,OAAQ,SAAQ,iBAAiB;IAC5C;;;;;OAKG;IACG,YAAY,EAAE,MAAM,CAAC;YACb,mBAAmB;IAW1B,gBAAgB;IAKvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACS,QAAQ,EAAE,eAAe,CAAC;IACtC;;;;OAIG;IACS,SAAS,EAAE,aAAa,EAAE,CAAoB;IAC1D;;;;;;;OAOG;IACS,UAAU,EAAE,WAAW,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAW;IACnC;;;OAGG;IACS,IAAI,EAAE,GAAG,CAAM;IAC3B;;;;OAIG;IACS,KAAK,EAAE,MAAM,CAAC;IAC1B,YAAY;IAIZ;;OAEG;IACH,aAAa;IAuBb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW;IAO3B,oBAAoB;CAKrB"}
package/dist/dts/form.d.ts CHANGED
@@ -10,12 +10,14 @@ export declare const renderers: any[];
10
10
  * Foundation form component for automatically generated forms based on json schema
11
11
  * obtained from the api, supplied initial data or supplied JSON schema.
12
12
  * Allowing customisable form elements using UI schema and set of custom renderers
13
+ * @element foundation-form
13
14
  * @beta
14
15
  */
15
16
  export declare class Form extends FoundationElement {
16
17
  /**
17
18
  * Name of the backend resource which will provide metadata
18
19
  * used to generate form and later used for submitting data
20
+ * @attr
19
21
  * @public
20
22
  */
21
23
  resourceName: string;
@@ -23,7 +25,6 @@ export declare class Form extends FoundationElement {
23
25
  private removeDataProperties;
24
26
  /**
25
27
  * UI schema used to define configuration of the layout and elements in the form
26
- * Check {@link UiSchemaElement} for possible options
27
28
  *
28
29
  * @remarks
29
30
  * If not provided will be autogenerated based on json schema or initial data
@@ -58,11 +59,13 @@ export declare class Form extends FoundationElement {
58
59
  * };
59
60
  * ```
60
61
  * @public
62
+ * @attr :uischema
61
63
  */
62
64
  uischema: UISchemaElement;
63
65
  /**
64
66
  * Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs
65
67
  * @public
68
+ * @attr :renderers
66
69
  */
67
70
  renderers: RendererEntry[];
68
71
  /**
@@ -71,12 +74,14 @@ export declare class Form extends FoundationElement {
71
74
  * @remarks
72
75
  * Use this when you want to avoid fetching metadata from the server but
73
76
  * be aware that it could get out of sync if metadata changes on the server
77
+ * @attr :jsonSchema
74
78
  */
75
79
  jsonSchema: JSONSchema7;
76
80
  private errors;
77
81
  private connect;
78
82
  /**
79
83
  * Initial data for the form
84
+ * @attr :data
80
85
  * @public
81
86
  */
82
87
  data: any;
@@ -88,6 +93,9 @@ export declare class Form extends FoundationElement {
88
93
  * @internal
89
94
  */
90
95
  submitted: boolean;
96
+ /**
97
+ * @attr {boolean}
98
+ */
91
99
  readonly: boolean;
92
100
  /**
93
101
  * @internal
package/dist/dts/form.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/form.ts"],"names":[],"mappings":"AAEA,OAAO,EAKL,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAc1C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,MAAM,gDAAkC,CAAC;AActD,cAAc;AACd,eAAO,MAAM,SAAS,OAYrB,CAAC;AACF;;;;;GAKG;AAEH,qBAKa,IAAK,SAAQ,iBAAiB;IACzC;;;;OAIG;IACG,YAAY,EAAE,MAAM,CAAC;YACb,mBAAmB;IAQjC,OAAO,CAAC,oBAAoB;IA0B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACS,QAAQ,EAAE,eAAe,CAAC;IACtC;;;OAGG;IACS,SAAS,EAAE,aAAa,EAAE,CAAa;IACnD;;;;;;OAMG;IACS,UAAU,EAAE,WAAW,CAAC;IAEpC,OAAO,CAAC,MAAM,CAAqB;IAC1B,OAAO,CAAC,OAAO,CAAW;IACnC;;;OAGG;IACS,IAAI,EAAE,GAAG,CAAM;IAE3B;;OAEG;IACS,UAAU,EAAE,OAAO,CAAC;IAChC;;OAEG;IACS,SAAS,EAAE,OAAO,CAAC;IAEJ,QAAQ,EAAE,OAAO,CAAC;IAE7C;;OAEG;IACG,OAAO;IAwBb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW;IAQ3B,oBAAoB;CAMrB"}
1
+ {"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/form.ts"],"names":[],"mappings":"AAEA,OAAO,EAKL,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAc1C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,MAAM,gDAAkC,CAAC;AActD,cAAc;AACd,eAAO,MAAM,SAAS,OAYrB,CAAC;AACF;;;;;;GAMG;AACH,qBAKa,IAAK,SAAQ,iBAAiB;IACzC;;;;;OAKG;IACG,YAAY,EAAE,MAAM,CAAC;YACb,mBAAmB;IAQjC,OAAO,CAAC,oBAAoB;IA0B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACS,QAAQ,EAAE,eAAe,CAAC;IACtC;;;;OAIG;IACS,SAAS,EAAE,aAAa,EAAE,CAAa;IACnD;;;;;;;OAOG;IACS,UAAU,EAAE,WAAW,CAAC;IAEpC,OAAO,CAAC,MAAM,CAAqB;IAC1B,OAAO,CAAC,OAAO,CAAW;IACnC;;;;OAIG;IACS,IAAI,EAAE,GAAG,CAAM;IAE3B;;OAEG;IACS,UAAU,EAAE,OAAO,CAAC;IAChC;;OAEG;IACS,SAAS,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACwB,QAAQ,EAAE,OAAO,CAAC;IAE7C;;OAEG;IACG,OAAO;IAwBb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW;IAQ3B,oBAAoB;CAMrB"}
package/dist/esm/filters/filters.js CHANGED
@@ -48,6 +48,7 @@ export const filtersRenderers = [
48
48
  * Foundation filters component for automatically generated filters based on json schema
49
49
  * obtained from the api, supplied initial data or supplied JSON schema.
50
50
  * Allowing customisable filters elements using UI schema and set of custom renderers
51
+ * @element foundation-filters
51
52
  * @beta
52
53
  */
53
54
  let Filters = class Filters extends FoundationElement {
@@ -55,6 +56,7 @@ let Filters = class Filters extends FoundationElement {
55
56
  super(...arguments);
56
57
  /**
57
58
  * Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs
59
+ * @attr :renderers
58
60
  * @public
59
61
  */
60
62
  this.renderers = filtersRenderers;
package/dist/esm/form.js CHANGED
@@ -46,6 +46,7 @@ export const renderers = [
46
46
  * Foundation form component for automatically generated forms based on json schema
47
47
  * obtained from the api, supplied initial data or supplied JSON schema.
48
48
  * Allowing customisable form elements using UI schema and set of custom renderers
49
+ * @element foundation-form
49
50
  * @beta
50
51
  */
51
52
  let Form = class Form extends FoundationElement {
@@ -54,11 +55,13 @@ let Form = class Form extends FoundationElement {
54
55
  /**
55
56
  * Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs
56
57
  * @public
58
+ * @attr :renderers
57
59
  */
58
60
  this.renderers = renderers;
59
61
  this.errors = [];
60
62
  /**
61
63
  * Initial data for the form
64
+ * @attr :data
62
65
  * @public
63
66
  */
64
67
  this.data = {};
package/docs/api-report.md CHANGED
@@ -58,21 +58,17 @@ export const filtersLogger: Logger;
58
58
  // @public (undocumented)
59
59
  export const filtersRenderers: any[];
60
60
 
61
- // @beta
61
+ // @public
62
62
  export class Form extends FoundationElement {
63
- // @public
64
63
  data: any;
65
64
  // (undocumented)
66
65
  disconnectedCallback(): void;
67
- // @public
68
66
  jsonSchema: JSONSchema7;
69
67
  // @internal (undocumented)
70
68
  onChange(event: CustomEvent): void;
71
69
  // (undocumented)
72
70
  readonly: boolean;
73
- // @public
74
71
  renderers: RendererEntry[];
75
- // @public
76
72
  resourceName: string;
77
73
  // @internal (undocumented)
78
74
  _submit(): Promise<void>;
@@ -80,7 +76,6 @@ export class Form extends FoundationElement {
80
76
  submitted: boolean;
81
77
  // @internal (undocumented)
82
78
  submitting: boolean;
83
- // @public
84
79
  uischema: UISchemaElement;
85
80
  }
86
81
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-forms",
3
3
  "description": "Genesis Foundation Forms",
4
- "version": "14.12.0",
4
+ "version": "14.12.1-web-types.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -9,6 +9,12 @@
9
9
  "engines": {
10
10
  "node": ">=16.0.0"
11
11
  },
12
+ "wca": {
13
+ "webtypesConfig": {
14
+ "default-icon": "<svg width='26' height='26' viewBox='0 0 26 26' fill='none' xmlns='http://www.w3.org/2000/svg'><path d='M18.7702 23.0437C18.7702 22.4675 18.8526 21.8089 19.0995 21.3149C19.3465 20.7386 19.6758 20.2447 20.0874 19.833C20.4991 19.4214 20.993 19.0921 21.5693 18.8451C22.1456 18.5982 22.7219 18.5158 23.2981 18.5158H25.9326V11.6828H19.1819V14.3172C19.1819 15.5521 18.6879 16.7047 17.8647 17.5279C17.0414 18.3512 15.8888 18.8451 14.7363 18.9275H6.7507V6.99025H16.4651V0.157227H3.54C2.63442 0.157227 1.72884 0.568855 1.07023 1.22746C0.411628 1.88606 0 2.79165 0 3.77955V22.2205C0 23.1261 0.411628 24.0316 1.07023 24.7726C1.72884 25.4312 2.63442 25.8428 3.54 25.8428H18.7702V23.0437Z' fill='white'/></svg>",
15
+ "description-markup": "markdown"
16
+ }
17
+ },
12
18
  "exports": {
13
19
  ".": {
14
20
  "types": "./dist/dts/index.d.ts",
@@ -19,11 +25,12 @@
19
25
  "config": {
20
26
  "PORT": 3090
21
27
  },
28
+ "web-types": "./web-types.json",
22
29
  "scripts": {
23
30
  "api": "npm run api:extract && npm run api:document",
24
31
  "api:extract": "api-extractor run",
25
32
  "api:document": "api-documenter markdown -i dist -o docs/api",
26
- "build": "npm run clean && npm run build:tsc && npm run api",
33
+ "build": "npm run clean && npm run build:tsc",
27
34
  "build:rollup": "rollup -c",
28
35
  "build:rollup:stats": "cross-env ANALYZE=1 npm run build:rollup",
29
36
  "build:tsc": "tsc -b ./tsconfig.json",
@@ -45,10 +52,14 @@
45
52
  "test:unit:browser:watch": "npm run test:unit:browser -- -w -d",
46
53
  "test:unit:node": "npm run test:unit:node:src",
47
54
  "test:unit:node:src": "uvu -r tsm -r esm -r ./jsdom.setup.ts ./src \".*.test.ts\"",
48
- "test:unit:watch": "watchlist src test -- npm run test:unit"
55
+ "test:unit:watch": "watchlist src test -- npm run test:unit",
56
+ "modify-json": "node ../../../build/web-types-cleaner.js web-types.json",
57
+ "web-types:analyze": "wca-webtypes analyze src --format webtypes --outFile web-types.json",
58
+ "custom-data:analyze": "wca-webtypes analyze src --format vscode --outFile vscode.html-custom-data.json",
59
+ "all:analyze": "npm run web-types:analyze && npm run custom-data:analyze && npm run modify-json"
49
60
  },
50
61
  "devDependencies": {
51
- "@genesislcap/foundation-testing": "^14.12.0",
62
+ "@genesislcap/foundation-testing": "14.12.1-web-types.1",
52
63
  "@microsoft/api-documenter": "^7.19.13",
53
64
  "@microsoft/api-extractor": "^7.31.1",
54
65
  "@module-federation/dashboard-plugin": "2.3.0",
@@ -92,6 +103,7 @@
92
103
  "typescript": "^4.5.5",
93
104
  "uvu": "0.5.4",
94
105
  "watchlist": "^0.3.1",
106
+ "web-component-analyzer-webtypes": "2.0.10",
95
107
  "webpack": "^5.45.1",
96
108
  "webpack-bundle-analyzer": "^4.5.0",
97
109
  "webpack-cli": "^4.5.0",
@@ -99,9 +111,9 @@
99
111
  "webpack-merge": "^5.7.3"
100
112
  },
101
113
  "dependencies": {
102
- "@genesislcap/foundation-comms": "^14.12.0",
103
- "@genesislcap/foundation-criteria": "^14.12.0",
104
- "@genesislcap/foundation-utils": "^14.12.0",
114
+ "@genesislcap/foundation-comms": "14.12.1-web-types.1",
115
+ "@genesislcap/foundation-criteria": "14.12.1-web-types.1",
116
+ "@genesislcap/foundation-utils": "14.12.1-web-types.1",
105
117
  "@jsonforms/core": "^3.0.0",
106
118
  "@microsoft/fast-components": "^2.21.3",
107
119
  "@microsoft/fast-element": "^1.7.0",
@@ -121,5 +133,5 @@
121
133
  "publishConfig": {
122
134
  "access": "public"
123
135
  },
124
- "gitHead": "f84b4de93910209defc04617003570694119d368"
136
+ "gitHead": "a4276897a8c2de488adb04a7f2d63bdc7aaae53c"
125
137
  }
package/vscode.html-custom-data.json ADDED
@@ -0,0 +1,68 @@
1
+ {
2
+ "version": 1,
3
+ "tags": [
4
+ {
5
+ "name": "foundation-filters",
6
+ "description": "Foundation filters component for automatically generated filters based on json schema\nobtained from the api, supplied initial data or supplied JSON schema.\nAllowing customisable filters elements using UI schema and set of custom renderers\n\nEvents:\n\n * `change` {`Event`} - \n\nAttributes:\n\n * `resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate filters\n\n * `:uischema` {`UISchemaElement`} - [object Object],[object Object],[object Object]\n\n * `:renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs\n\n * `:jsonschema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\n * `:value` {`string`} - Created criteria based on the given data that can be used to filter the data\n\nProperties:\n\n * `resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate filters\n\n * `uischema` {`UISchemaElement`} - [object Object],[object Object],[object Object]\n\n * `renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs\n\n * `jsonSchema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\n * `connect` {`Connect`} - \n\n * `data` - Initial data for the filters\n\n * `value` {`string`} - Created criteria based on the given data that can be used to filter the data\n\n * `_presentation` - \n\n * `$presentation` {`ComponentPresentation | null`} - A property which resolves the ComponentPresentation instance\r\nfor the current component.\n\n * `template` {`void | ElementViewTemplate | null`} - Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.\n\n * `styles` - Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.\n\n * `$fastController` - The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
7
+ "attributes": [
8
+ {
9
+ "name": "resourceName",
10
+ "description": "`resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate filters\n\nProperty: resourceName"
11
+ },
12
+ {
13
+ "name": ":uischema",
14
+ "description": "`:uischema` {`UISchemaElement`} - [object Object],[object Object],[object Object]\n\nProperty: uischema"
15
+ },
16
+ {
17
+ "name": ":renderers",
18
+ "description": "`:renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs\n\nProperty: renderers\n\nDefault: [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]"
19
+ },
20
+ {
21
+ "name": ":jsonschema",
22
+ "description": "`:jsonschema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\nProperty: jsonSchema"
23
+ },
24
+ {
25
+ "name": ":value",
26
+ "description": "`:value` {`string`} - Created criteria based on the given data that can be used to filter the data\n\nProperty: value"
27
+ },
28
+ {
29
+ "name": "onchange",
30
+ "description": "`change` {`Event`} - "
31
+ }
32
+ ]
33
+ },
34
+ {
35
+ "name": "foundation-form",
36
+ "description": "Foundation form component for automatically generated forms based on json schema\nobtained from the api, supplied initial data or supplied JSON schema.\nAllowing customisable form elements using UI schema and set of custom renderers\n\nAttributes:\n\n * `resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate form and later used for submitting data\n\n * `:uischema` {`UISchemaElement`} - UI schema used to define configuration of the layout and elements in the form\n\n * `:renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs\n\n * `:jsonSchema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\n * `:data` - Initial data for the form\n\n * `readonly` {boolean} - \n\nProperties:\n\n * `resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate form and later used for submitting data\n\n * `uischema` {`UISchemaElement`} - UI schema used to define configuration of the layout and elements in the form\n\n * `renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs\n\n * `jsonSchema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\n * `errors` {`ErrorObject<string, Record<string, any>, unknown>[]`} - \n\n * `connect` {`Connect`} - \n\n * `data` - Initial data for the form\n\n * `submitting` {`boolean`} - \n\n * `submitted` {`boolean`} - \n\n * `readonly` {boolean} - \n\n * `_presentation` - \n\n * `$presentation` {`ComponentPresentation | null`} - A property which resolves the ComponentPresentation instance\r\nfor the current component.\n\n * `template` {`void | ElementViewTemplate | null`} - Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.\n\n * `styles` - Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.\n\n * `$fastController` - The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
37
+ "attributes": [
38
+ {
39
+ "name": "resourceName",
40
+ "description": "`resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate form and later used for submitting data\n\nProperty: resourceName"
41
+ },
42
+ {
43
+ "name": ":uischema",
44
+ "description": "`:uischema` {`UISchemaElement`} - UI schema used to define configuration of the layout and elements in the form\n\nProperty: uischema"
45
+ },
46
+ {
47
+ "name": ":renderers",
48
+ "description": "`:renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs\n\nProperty: renderers\n\nDefault: [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]"
49
+ },
50
+ {
51
+ "name": ":jsonSchema",
52
+ "description": "`:jsonSchema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\nProperty: jsonSchema"
53
+ },
54
+ {
55
+ "name": ":data",
56
+ "description": "`:data` - Initial data for the form\n\nProperty: data\n\nDefault: [object Object]"
57
+ },
58
+ {
59
+ "name": "readonly",
60
+ "description": "`readonly` {boolean} - \n\nProperty: readonly",
61
+ "valueSet": "v"
62
+ }
63
+ ]
64
+ }
65
+ ],
66
+ "globalAttributes": [],
67
+ "valueSets": []
68
+ }
package/web-types.json ADDED
@@ -0,0 +1,193 @@
1
+ {
2
+ "$schema": "http://json.schemastore.org/web-types",
3
+ "name": "@genesislcap/foundation-forms",
4
+ "version": "14.12.1",
5
+ "default-icon": "<svg width='26' height='26' viewBox='0 0 26 26' fill='none' xmlns='http://www.w3.org/2000/svg'><path d='M18.7702 23.0437C18.7702 22.4675 18.8526 21.8089 19.0995 21.3149C19.3465 20.7386 19.6758 20.2447 20.0874 19.833C20.4991 19.4214 20.993 19.0921 21.5693 18.8451C22.1456 18.5982 22.7219 18.5158 23.2981 18.5158H25.9326V11.6828H19.1819V14.3172C19.1819 15.5521 18.6879 16.7047 17.8647 17.5279C17.0414 18.3512 15.8888 18.8451 14.7363 18.9275H6.7507V6.99025H16.4651V0.157227H3.54C2.63442 0.157227 1.72884 0.568855 1.07023 1.22746C0.411628 1.88606 0 2.79165 0 3.77955V22.2205C0 23.1261 0.411628 24.0316 1.07023 24.7726C1.72884 25.4312 2.63442 25.8428 3.54 25.8428H18.7702V23.0437Z' fill='white'/></svg>",
6
+ "description-markup": "markdown",
7
+ "contributions": {
8
+ "html": {
9
+ "elements": [
10
+ {
11
+ "name": "foundation-filters",
12
+ "description": "Foundation filters component for automatically generated filters based on json schema\nobtained from the api, supplied initial data or supplied JSON schema.\nAllowing customisable filters elements using UI schema and set of custom renderers",
13
+ "source": {
14
+ "module": "./src/filters/filters.ts",
15
+ "symbol": "Filters"
16
+ },
17
+ "attributes": [
18
+ {
19
+ "name": "resourceName",
20
+ "required": false,
21
+ "priority": "normal",
22
+ "value": {
23
+ "type": "string",
24
+ "required": true
25
+ },
26
+ "description": "Name of the backend resource which will provide metadata\nused to generate filters",
27
+ "source": {
28
+ "module": "./src/filters/filters.ts",
29
+ "symbol": "Filters.resourceName"
30
+ }
31
+ },
32
+ {
33
+ "name": ":uischema",
34
+ "required": false,
35
+ "priority": "normal",
36
+ "value": {
37
+ "type": "UISchemaElement",
38
+ "required": true
39
+ },
40
+ "description": "[object Object],[object Object],[object Object]",
41
+ "source": {
42
+ "module": "./src/filters/filters.ts",
43
+ "symbol": "Filters.uischema"
44
+ }
45
+ },
46
+ {
47
+ "name": ":renderers",
48
+ "required": false,
49
+ "priority": "normal",
50
+ "value": {
51
+ "type": "RendererEntry[]",
52
+ "required": true,
53
+ "default": "[{\"renderer\":\"StringControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"StringControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"BooleanControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"LayoutVertical2ColumnsRendererTemplate\",\"mapper\":\"mapStateToLayoutProps\"},{\"renderer\":\"LayoutRendererTemplate\",\"mapper\":\"mapStateToLayoutProps\"},{\"renderer\":\"FilterNumberControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"ConnectedMultiselectControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"EnumControlRendererTemplate\",\"mapper\":\"mapStateToEnumControlProps\"},{\"renderer\":\"ConnectedSelectControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"DateControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"InvisibleControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"}]"
54
+ },
55
+ "description": "Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs",
56
+ "source": {
57
+ "module": "./src/filters/filters.ts",
58
+ "symbol": "Filters.renderers"
59
+ }
60
+ },
61
+ {
62
+ "name": ":jsonschema",
63
+ "required": false,
64
+ "priority": "normal",
65
+ "value": {
66
+ "type": "JSONSchema7",
67
+ "required": true
68
+ },
69
+ "description": "[object Object],[object Object],[object Object]",
70
+ "source": {
71
+ "module": "./src/filters/filters.ts",
72
+ "symbol": "Filters.jsonSchema"
73
+ }
74
+ },
75
+ {
76
+ "name": ":value",
77
+ "required": false,
78
+ "priority": "normal",
79
+ "value": {
80
+ "type": "string",
81
+ "required": true
82
+ },
83
+ "description": "Created criteria based on the given data that can be used to filter the data",
84
+ "source": {
85
+ "module": "./src/filters/filters.ts",
86
+ "symbol": "Filters.value"
87
+ }
88
+ }
89
+ ]
90
+ },
91
+ {
92
+ "name": "foundation-form",
93
+ "description": "Foundation form component for automatically generated forms based on json schema\nobtained from the api, supplied initial data or supplied JSON schema.\nAllowing customisable form elements using UI schema and set of custom renderers",
94
+ "source": {
95
+ "module": "./src/form.ts",
96
+ "symbol": "Form"
97
+ },
98
+ "attributes": [
99
+ {
100
+ "name": "resourceName",
101
+ "required": false,
102
+ "priority": "normal",
103
+ "value": {
104
+ "type": "string",
105
+ "required": true
106
+ },
107
+ "description": "Name of the backend resource which will provide metadata\nused to generate form and later used for submitting data",
108
+ "source": {
109
+ "module": "./src/form.ts",
110
+ "symbol": "Form.resourceName"
111
+ }
112
+ },
113
+ {
114
+ "name": ":uischema",
115
+ "required": false,
116
+ "priority": "normal",
117
+ "value": {
118
+ "type": "UISchemaElement",
119
+ "required": true
120
+ },
121
+ "description": "UI schema used to define configuration of the layout and elements in the form",
122
+ "source": {
123
+ "module": "./src/form.ts",
124
+ "symbol": "Form.uischema"
125
+ }
126
+ },
127
+ {
128
+ "name": ":renderers",
129
+ "required": false,
130
+ "priority": "normal",
131
+ "value": {
132
+ "type": "RendererEntry[]",
133
+ "required": true,
134
+ "default": "[{\"renderer\":\"StringControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"StringControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"BooleanControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"LayoutVertical2ColumnsRendererTemplate\",\"mapper\":\"mapStateToLayoutProps\"},{\"renderer\":\"LayoutRendererTemplate\",\"mapper\":\"mapStateToLayoutProps\"},{\"renderer\":\"NumberControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"ConnectedMultiselectControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"EnumControlRendererTemplate\",\"mapper\":\"mapStateToEnumControlProps\"},{\"renderer\":\"ConnectedSelectControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"DateControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"InvisibleControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"}]"
135
+ },
136
+ "description": "Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs",
137
+ "source": {
138
+ "module": "./src/form.ts",
139
+ "symbol": "Form.renderers"
140
+ }
141
+ },
142
+ {
143
+ "name": ":jsonSchema",
144
+ "required": false,
145
+ "priority": "normal",
146
+ "value": {
147
+ "type": "JSONSchema7",
148
+ "required": true
149
+ },
150
+ "description": "[object Object],[object Object],[object Object]",
151
+ "source": {
152
+ "module": "./src/form.ts",
153
+ "symbol": "Form.jsonSchema"
154
+ }
155
+ },
156
+ {
157
+ "name": ":data",
158
+ "required": false,
159
+ "priority": "normal",
160
+ "value": {
161
+ "kind": "plain",
162
+ "type": "",
163
+ "required": true,
164
+ "default": "{}"
165
+ },
166
+ "description": "Initial data for the form",
167
+ "source": {
168
+ "module": "./src/form.ts",
169
+ "symbol": "Form.data"
170
+ }
171
+ },
172
+ {
173
+ "name": "readonly",
174
+ "required": false,
175
+ "priority": "normal",
176
+ "value": {
177
+ "type": "boolean",
178
+ "required": false
179
+ },
180
+ "source": {
181
+ "module": "./src/form.ts",
182
+ "symbol": "Form.readonly"
183
+ }
184
+ }
185
+ ]
186
+ }
187
+ ]
188
+ },
189
+ "css": {
190
+ "properties": []
191
+ }
192
+ }
193
+ }
package/dist/dts/tsdoc-metadata.json DELETED
@@ -1,11 +0,0 @@
1
- // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
- // It should be published with your NPM package. It should not be tracked by Git.
3
- {
4
- "tsdocVersion": "0.12",
5
- "toolPackages": [
6
- {
7
- "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.34.4"
9
- }
10
- ]
11
- }