@formbird/angular-elements 7.5.8 → 7.5.9

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@formbird/angular-elements",
3
- "version": "7.5.8",
3
+ "version": "7.5.9",
4
4
  "files": [
5
5
  "README.md",
6
6
  "LICENSE",
@@ -1,134 +0,0 @@
1
-  # Formbird Codespace
2
- Using the github codespace functionality we can now host and edit components through Github and Visual Studio Code Online.
3
- Component development can now be performed from within the browser with component updates only a refresh away.
4
-
5
- ## Create Codespace
6
- Open **Formbird** forbird-sc-components github here:
7
- >[formbird-sc-components](https://github.com/formbird/formbird-sc-components)
8
-
9
- Create the codespace environment
10
- > Click the green **<>Code**
11
- Select the **codespaces** tab
12
- Click the dropdown on right of **Create codespace on angular**
13
- Select **Configure and create codespace**
14
- Change machine type from **2-core** to **4-core**
15
- Click **Create codespace**
16
- Allow codespace to open. Once the page is loaded
17
-
18
- Once the page is loaded open terminal by...
19
- > **Ctrl `** <sub> (windows)</sub> or **CMD J**<sub>(mac)</sub>
20
-
21
- ## Set up Environment
22
- Now we want to set up the enironment as you would a local one.
23
- > To set up the dependencies.
24
- > **yarn**
25
-
26
- >If you have any issues try
27
- > **yarn cache clean**
28
-
29
- Then we want to compile and build the project
30
- > **yarn dist**
31
-
32
- Next time you want to use the environment you can simply navigate to the codespaces dropdown in formbird-sc-components and select from your codespaces
33
-
34
- ## Running the environment
35
- Once the environment is set up should just be able to run the following:
36
- > npx ng serve sc-components
37
-
38
- Newer update (11/8/22) to run :
39
- > yarn serve
40
-
41
- This will open a new tab and the url can then be supplied to component files in formbird.com
42
- > eg. https://formbird-formbird-sc-components-...-4200.githubpreview.dev/...
43
-
44
- Note you may have to change the **port visibility** to **Private to Organisation** or **Public**
45
- > To do this navigate to terminal in codespace
46
- > In the **TERMINAL** window, click on **PORTS** tab
47
- > Right click and select **port visibility**
48
- > Change to desired setting
49
-
50
- ## Using Codespace with formbird.com
51
- New angular components can use the simplified component template setup which uses the default page template definition
52
-
53
- Start by navigating to the codespace directory
54
- > formbird-sc-components/projects
55
-
56
- Locate the component that requires development. If you are creating a new one seek Michaels help :)
57
- > eg. sc-signature
58
-
59
- Next find the src app code
60
- > sc-signature/src/app/signature
61
-
62
- In signature.module.ts under class add a new custom element field which allows the formbird api to reference the application using the name you provide. Note we will be hosting the component as **sc-signature-new** to avoid conflicts with previous version.
63
- >eg. customElementService.convertToCustomElement(SignatureComponent, 'sc-signature-new', this.injector, ClientConstants.ANGULAR_COMPONENT_SUFFIX, pjson.version);
64
-
65
- Open [comp-dev-ng - Template Editor](https://comp-dev-ng.formbird.com/form/74746c80-8378-11e6-99b1-71ee944cf59f)
66
- Add relevant details to template. Note can use [component editor](https://comp-dev-ng.formbird.com/form/5f6000a0-0828-11e6-9b64-1b27992111e1) to create component.
67
- >{{
68
- **"name": "sc-signature-new",
69
- "componentHtml": "",
70
- "fieldWatchFunction": "",
71
- "componentLoadFunction": "",
72
- "systemHeader": {
73
- "systemType": "component",
74
- "templateId": "5f6000a0-0828-11e6-9b64-1b27992111e1",
75
- "createdWith": "5f6000a0-0828-11e6-9b64-1b27992111e1",
76
- "currentVersion": true,
77
- "summaryName": "sc-signature-new",
78
- "keyIds": [],
79
- "createdDate": "2022-07-28T05:23:51.192Z",
80
- "createdBy": "599f95d0-936a-11ec-b26d-7da72dab73ce",
81
- "documentCreatedDate": "2022-07-27T07:43:41.136Z",
82
- "documentCreatedBy": "540e51dd83fb24502699c93f",
83
- "versionId": "770f9980-0e35-11ed-9977-79b0183037a9",
84
- "serverUpdatedDate": "2022-07-28T05:23:50.778Z",
85
- "serverCreatedDate": "2022-07-28T05:23:50.778Z",
86
- "previousVersionId": "53e05620-0e35-11ed-9977-79b0183037a9"
87
- },
88
- "documentId": "acda2aa0-0d7f-11ed-ab35-db46d5f5bdd1",
89
- "versionInfo": "ANGULAR_COMPONENT_RELEASE",
90
- "appTags": [
91
- "system",
92
- "components",
93
- "componentDefinition"
94
- ],
95
- "componentTestUrlLink": "/form/2504aeb0-7448-11e6-949c-9f3b8c69d8b6",
96
- "versionNumber": "7.0",
97
- "componentDescription": "####Configuration Fields\n| Field | Values | Default (if not present) | Details | \n | ---- | ---- | ---- | ---- | \n | name |` values `| not-set | description |\n####Description\nAllows a signature or screen writing to be captured",
98
- "restfulWebServiceFunctions": "",
99
- "serverPreprocessorFunction": "",
100
- "componentCleanupFunction": "",
101
- "vendorLibrariesRel": [
102
- {
103
- "documentId": "ef1dbb2d-2c0e-4f1c-a42d-77c1562be6b2",
104
- "name": "formbirdAngularElementsStylesProdCDN",
105
- **"fileName": "https://formbird-formbird-sc-components-....githubpreview.dev/styles.css"**
106
- },
107
- {
108
- "documentId": "58d8730c-3ff6-4856-9401-0c15f42f4455",
109
- "name": "formbirdAngularElementsRunTimeProdCDN",
110
- **"fileName": "https://formbird-formbird-sc-components-....githubpreview.dev/runtime.js"**
111
- },
112
- {
113
- "documentId": "abaaad2b-90fd-4b7b-b767-792b85dfb93f",
114
- "name": "formbirdAngularElementsPolyfillsProdCDN",
115
- **"fileName": "https://formbird-formbird-sc-components-....githubpreview.dev/polyfills.js"**
116
- },
117
- {
118
- "documentId": "7b431aa0-0173-4cdc-ba74-c6c729f03e91",
119
- "name": "formbirdAngularElementsMainProdCDN",
120
- **"fileName": "https://formbird-formbird-sc-components-....githubpreview.dev/main.js"**
121
- }
122
- ],
123
- "compDevTestUrlLink": "/form/2504aeb0-7448-11e6-949c 9f3b8c69d8b6"
124
- }
125
-
126
- In the case of sc-signature-new all we have to do now to host the component is ensure the codespace environment is running and we change the 4 **filename** prefixes to our github url inside the vendorLibrariesRel object.
127
- >eg. filename: https://formbird-formbird-sc-components-....githubpreview.dev/
128
- >
129
- ## sc-signature-new documents for reference
130
- Signature example template:
131
- https://comp-dev-ng.formbird.com/form/2720cf30-0d80-11ed-9b16-af366aef3293
132
-
133
- Component template:
134
- https://comp-dev-ng.formbird.com/form/acda2aa0-0d7f-11ed-ab35-db46d5f5bdd1/74746c80-8378-11e6-99b1-71ee944cf59f
@@ -1,4 +0,0 @@
1
- {
2
- // For more information, visit: https://go.microsoft.com/fwlink/?linkid=827846
3
- "recommendations": ["angular.ng-template"]
4
- }
@@ -1,20 +0,0 @@
1
- {
2
- // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
3
- "version": "0.2.0",
4
- "configurations": [
5
- {
6
- "name": "ng serve",
7
- "type": "pwa-chrome",
8
- "request": "launch",
9
- "preLaunchTask": "npm: start",
10
- "url": "http://localhost:4200/"
11
- },
12
- {
13
- "name": "ng test",
14
- "type": "chrome",
15
- "request": "launch",
16
- "preLaunchTask": "npm: test",
17
- "url": "http://localhost:9876/debug.html"
18
- }
19
- ]
20
- }
@@ -1,42 +0,0 @@
1
- {
2
- // For more information, visit: https://go.microsoft.com/fwlink/?LinkId=733558
3
- "version": "2.0.0",
4
- "tasks": [
5
- {
6
- "type": "npm",
7
- "script": "start",
8
- "isBackground": true,
9
- "problemMatcher": {
10
- "owner": "typescript",
11
- "pattern": "$tsc",
12
- "background": {
13
- "activeOnStart": true,
14
- "beginsPattern": {
15
- "regexp": "(.*?)"
16
- },
17
- "endsPattern": {
18
- "regexp": "bundle generation complete"
19
- }
20
- }
21
- }
22
- },
23
- {
24
- "type": "npm",
25
- "script": "test",
26
- "isBackground": true,
27
- "problemMatcher": {
28
- "owner": "typescript",
29
- "pattern": "$tsc",
30
- "background": {
31
- "activeOnStart": true,
32
- "beginsPattern": {
33
- "regexp": "(.*?)"
34
- },
35
- "endsPattern": {
36
- "regexp": "bundle generation complete"
37
- }
38
- }
39
- }
40
- }
41
- ]
42
- }