Merge pull request #91 from oneblink/ON-6263

ON-6263 # Added slug property to organisation and forms app

Author: Zaxist

CHANGELOG.md

@@ -5,6 +5,8 @@
 ### Added
 
 - Summary Element to Element types
+- `slug` property to Forms Apps
+- `slug` property to Organisations
 
 # 0.5.0 (2020-05-14)
 

docs/forms-apps.md

@@ -40,7 +40,7 @@ Create a Forms App
 ```javascript
 const formsApp = {
   name: 'My Application',
-  hostname: 'customer-my.app.oneblink.io',
+  slug: 'my',
   pwaSettings: {
     homeScreenName: 'App',
     splashScreenName: 'Application',
@@ -60,7 +60,7 @@ formsAppsSDK.createFormsApp(formsApp).then((savedFormsApp) => {
 | ---------------------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `formsApp`                               | Yes      | `Object`   | Forms App properties                                                                                                                                                                                 |
 | `formsApp.name`                          | Yes      | `string`   | Name of the forms app                                                                                                                                                                                |
-| `formsApp.hostname`                      | Yes      | `string`   | Hostname (domain) for the forms app                                                                                                                                                                  |
+| `formsApp.slug`                          | Yes      | `string`   | Unique domain safe text to identify the app                                                                                                                                                          |
 | `formsApp.organisationId`                | Yes      | `string`   | The exact organisation identifier the forms app is associated with                                                                                                                                   |
 | `formsApp.formsAppEnvironmentId`         | Yes      | `number`   | The exact forms app environment identifier the forms app is associated with                                                                                                                          |
 | `formsApp.formIds`                       | Yes      | `number[]` | The identifiers of the forms that are in the forms app. The order of the forms is respected when rendering the list of forms                                                                         |
@@ -79,6 +79,7 @@ formsAppsSDK.createFormsApp(formsApp).then((savedFormsApp) => {
   "id": 1,
   "name": "My Application",
   "hostname": "customer-my.app.oneblink.io",
+  "slug": "my",
   "oAuthClientId": "123456789012abcdefghijkl",
   "styles": {},
   "pwaSettings": {

docs/organisations.md

@@ -49,7 +49,8 @@ organisations.getOrganisations(organisationId).then((organisation) => {
     "awsAccounts": ["ABCDEFG55678901HIJKL1234"]
   },
   "tags": ["Organisation Tag"],
-  "formsHostname": "example.forms.oneblink.io",
+  "assetsS3Bucket": "example.forms.oneblink.io",
+  "slug": "example",
   "beeFormsCustomer": false
 }
 ```

flow-typed/types.js

@@ -76,7 +76,8 @@ declare type Key = {
 declare type Organisation = {
   id: string,
   name: string,
-  formsHostname: string,
+  assetsS3Bucket: string,
+  slug: string,
   formsCloudFrontDistributionOrigin?: string,
   beeFormsCustomer: boolean,
   createdAt: string,
@@ -117,6 +118,7 @@ declare type FormsAppStyles = {
 declare type FormsApp = {
   id: number,
   name: string,
+  slug: string,
   hostname: string,
   oAuthClientId: ?string,
   createdAt: string,

tests/lib/forms.test.js

@@ -29,6 +29,7 @@ describe('Forms SDK Class', () => {
               id: 1,
               name: 'appname',
               hostname: 'orgname-appname.apps.oneblink.io',
+              slug: 'appname',
             })
           }
         }