@projectcaluma/ember-form 14.5.0 → 14.6.0

package/README.md

@@ -0,0 +1,82 @@
+# ![ember-caluma](https://user-images.githubusercontent.com/6150577/137114875-8b9edb83-92ba-4b3a-ba6e-2e5f86afdcc5.png)
+
+[![Test](https://github.com/projectcaluma/ember-caluma/workflows/Test/badge.svg)](https://github.com/projectcaluma/ember-caluma/actions?query=workflow%3ATest)
+[![BrowserStack Status](https://automate.browserstack.com/badge.svg?badge_key=RFNMT2hyTnRjNVZkUitkWUl2d3BWK21KbnU3MU1tTGpHS2tOVHVCU1RrZz0tLXJjZ1J5VEZ6ZmtJWVpFdHpDRnREcFE9PQ==--3034affde596526379b7a0a19798a7ba1f79154c)](https://automate.browserstack.com/public-build/RFNMT2hyTnRjNVZkUitkWUl2d3BWK21KbnU3MU1tTGpHS2tOVHVCU1RrZz0tLXJjZ1J5VEZ6ZmtJWVpFdHpDRnREcFE9PQ==--3034affde596526379b7a0a19798a7ba1f79154c)
+[![Codecov](https://codecov.io/gh/projectcaluma/ember-caluma/branch/main/graph/badge.svg)](https://codecov.io/gh/projectcaluma/ember-caluma)
+[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![License: LGPL-3.0](https://img.shields.io/badge/License-LGPL--3.0-blue.svg)](https://spdx.org/licenses/LGPL-3.0-or-later.html)
+
+The Ember.js addons for [Caluma](https://caluma.io) - a collaborative form editing service.
+
+## Browser support
+
+| ![Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png) |
+| :-------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: |
+|                                        last 2 versions                                        |                                            last 2 versions                                             |                                           last 2 versions                                           |                                               last 2 versions                                               |
+
+## Compatibility
+
+`@projectcaluma/ember-*` packages are guaranteed to work with the following LTS versions of Ember.js:
+
+- 5.4
+- 4.12
+
+## Documentation
+
+You can find the interactive documentation [here](https://docs.caluma.io/ember-caluma).
+
+## Contributing
+
+### Installation
+
+- `git clone git@github.com:projectcaluma/ember-caluma`
+- `cd ember-caluma`
+- `pnpm install`
+
+### Linting
+
+- `pnpm lint`
+
+### Running tests
+
+- `pnpm --filter @projectcaluma/ember-[package] exec ember test` – Runs the test suite on the current Ember version
+- `pnpm --filter @projectcaluma/ember-[package] exec ember test --server` – Runs the test suite in "watch mode"
+- `pnpm --filter @projectcaluma/ember-[package] exec ember try:each` – Runs the test suite against multiple Ember versions
+
+Cross-browser testing provided by:
+
+<a href="https://browserstack.com"><img alt="BrowserStack" src="https://user-images.githubusercontent.com/6150577/69328224-24f1d680-0c4f-11ea-8b02-5670334923a3.png" height="50"></a>
+
+### Running the dummy application
+
+#### With a mocked [Mirage.js](https://github.com/miragejs/ember-cli-mirage) backend
+
+- `pnpm start`
+- Visit the dummy application at [http://localhost:4200](http://localhost:4200).
+
+#### With a dockerized [Caluma](https://github.com/projectcaluma/caluma) backend
+
+- `docker compose up -d`
+- `pnpm start-proxy`
+- Visit the dummy application at [http://localhost:4200](http://localhost:4200).
+
+### Updating the schema
+
+The addon includes a mirage server for mocking Caluma's GraphQL API, which is generated from the GraphQL schema definition. If the upstream GraphQL schema changed you can update the addon by running
+
+```bash
+docker compose up -d
+pnpm update-schema
+pnpm update-possible-types
+```
+
+### Releasing
+
+To release a new version, head over to [Actions](https://github.com/projectcaluma/ember-caluma/actions?query=workflow%3ARelease) and trigger a workflow run.
+This will automatically check if a new version can be released, generate a changelog, draft a release and publish it on NPM.
+
+## License
+
+This project is licensed under the [LGPL-3.0-or-later license](LICENSE).
+
+For further information on our license choice, you can read up on the [corresponding GitHub issue](https://github.com/projectcaluma/ember-caluma/issues/613).

package/addon/components/cf-field/input/files.js

@@ -1,9 +1,9 @@
 import { action } from "@ember/object";
 import { inject as service } from "@ember/service";
+import { waitForFetch } from "@ember/test-waiters";
 import { macroCondition, isTesting } from "@embroider/macros";
 import Component from "@glimmer/component";
 import { queryManager } from "ember-apollo-client";
-import fetch from "fetch";
 
 import getFilesAnswerInfoQuery from "@projectcaluma/ember-form/gql/queries/filesanswer-info.graphql";
 
@@ -75,10 +75,12 @@ export default class CfFieldInputFilesComponent extends Component {
       }));
 
       const uploadFunction = async (file) => {
-        const response = await fetch(file.uploadUrl, {
-          method: "PUT",
-          body: file.value,
-        });
+        const response = await waitForFetch(
+          fetch(file.uploadUrl, {
+            method: "PUT",
+            body: file.value,
+          }),
+        );
         if (!response.ok) {
           throw new Error();
         }

package/addon/lib/base.js

@@ -2,6 +2,7 @@ import { setOwner } from "@ember/application";
 import { assert } from "@ember/debug";
 import { registerDestructor } from "@ember/destroyable";
 import { inject as service } from "@ember/service";
+import { cached } from "tracked-toolbox";
 
 export default class Base {
   @service calumaStore;
@@ -18,8 +19,8 @@ export default class Base {
     }
 
     registerDestructor(this, () => {
-      if (this.pk) {
-        this.calumaStore.delete(this.pk);
+      if (this.storeKey) {
+        this.calumaStore.delete(this.storeKey);
       }
     });
   }
@@ -31,13 +32,34 @@ export default class Base {
    */
   raw = {};
 
+  /**
+   * The primary key of the lib class.
+   * Must be overridden in subclasses.
+   *
+   * @property {String} pk
+   */
+  @cached
+  get pk() {
+    throw new Error("pk getter must be implemented in subclass");
+  }
+
+  /**
+   * The caluma store key of the answer.
+   *
+   * @property {String} storeKey
+   */
+  @cached
+  get storeKey() {
+    return this.pk;
+  }
+
   /**
    * Push the object into the caluma store
    *
    * @method pushIntoStore
    */
   pushIntoStore() {
-    if (this.pk) {
+    if (this.storeKey) {
       this.calumaStore.push(this);
     }
   }

package/addon/lib/field.js

@@ -177,6 +177,17 @@ export default class Field extends Base {
     return `${this.document.pk}:Question:${this.raw.question.slug}`;
   }
 
+  /**
+   * The caluma store key of the field.
+   * The form primary key is added for re-used fields in different forms.
+   *
+   * @property {String} storeKey
+   */
+  @cached
+  get storeKey() {
+    return `${this.fieldset.storeKey}:Question:${this.raw.question.slug}`;
+  }
+
   /**
    * The element ID used by the label component.
    *

package/addon/lib/fieldset.js

@@ -52,9 +52,7 @@ export default class Fieldset extends Base {
     const fields = this.raw.form.questions.map((question) => {
       return associateDestroyableChild(
         this,
-        this.calumaStore.find(
-          `${this.document.pk}:Question:${question.slug}`,
-        ) ||
+        this.calumaStore.find(`${this.pk}:Question:${question.slug}`) ||
           new (owner.factoryFor("caluma-model:field").class)({
             raw: {
               question,

package/addon/services/caluma-store.js

@@ -13,14 +13,14 @@ export default class CalumaStoreService extends Service {
   push(obj) {
     assert(
       `Object must have an \`pk\` in order to be pushed into the store`,
-      obj.pk,
+      obj.storeKey,
     );
 
-    const existing = this._store.get(obj.pk);
+    const existing = this._store.get(obj.storeKey);
 
     if (existing) {
       debug(
-        `Object with the pk \`${obj.pk}\` already exists in the store. It will be updated.`,
+        `Object with the storeKey \`${obj.storeKey}\` already exists in the store. It will be updated.`,
       );
 
       set(existing, "raw", obj.raw);
@@ -28,17 +28,17 @@ export default class CalumaStoreService extends Service {
       return existing;
     }
 
-    this._store.set(obj.pk, obj);
+    this._store.set(obj.storeKey, obj);
 
     return obj;
   }
 
-  find(pk) {
-    return this._store.get(pk) || null;
+  find(storeKey) {
+    return this._store.get(storeKey) || null;
   }
 
-  delete(pk) {
-    this._store.delete(pk);
+  delete(storeKey) {
+    this._store.delete(storeKey);
   }
 
   clear() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@projectcaluma/ember-form",
-  "version": "14.5.0",
+  "version": "14.6.0",
   "description": "Ember addon for rendering Caluma forms.",
   "keywords": [
     "ember-addon"
@@ -11,11 +11,10 @@
   "dependencies": {
     "@babel/core": "^7.26.0",
     "@ember/string": "^3.1.1 || ^4.0.0",
+    "@ember/test-waiters": "^4.1.1",
     "@embroider/macros": "^1.16.10",
     "@embroider/util": "^1.13.2",
-    "@glimmer/component": "^1.1.2",
-    "@glimmer/tracking": "^1.1.2",
-    "ember-apollo-client": "~4.0.2",
+    "ember-apollo-client": "^5.0.0",
     "ember-auto-import": "^2.10.0",
     "ember-autoresize-modifier": "^0.7.0 || ^0.8.0",
     "ember-basic-dropdown": "^8.4.0",
@@ -24,7 +23,6 @@
     "ember-cli-showdown": "^9.0.1",
     "ember-composable-helpers": "^5.0.0",
     "ember-concurrency": "^4.0.2",
-    "ember-fetch": "^8.1.2",
     "ember-flatpickr": "^8.0.1",
     "ember-in-viewport": "^4.1.0",
     "ember-intl": "^7.1.1",
@@ -41,13 +39,15 @@
     "luxon": "^3.5.0",
     "reactiveweb": "^1.3.0",
     "tracked-toolbox": "^2.0.0",
-    "@projectcaluma/ember-core": "^14.5.0"
+    "@projectcaluma/ember-core": "^14.6.0"
   },
   "devDependencies": {
     "@ember/optional-features": "2.2.0",
     "@ember/test-helpers": "4.0.4",
     "@embroider/test-setup": "4.0.0",
     "@faker-js/faker": "10.0.0",
+    "@glimmer/component": "1.1.2",
+    "@glimmer/tracking": "1.1.2",
     "broccoli-asset-rev": "3.0.0",
     "ember-cli": "6.1.0",
     "ember-cli-clean-css": "3.0.0",
@@ -72,12 +72,12 @@
     "uikit": "3.23.13",
     "uuid": "13.0.0",
     "webpack": "5.101.3",
-    "@projectcaluma/ember-testing": "14.5.0",
-    "@projectcaluma/ember-workflow": "14.5.0"
+    "@projectcaluma/ember-workflow": "14.6.0",
+    "@projectcaluma/ember-testing": "14.6.0"
   },
   "peerDependencies": {
     "ember-source": ">= 4.0.0",
-    "@projectcaluma/ember-workflow": "^14.5.0"
+    "@projectcaluma/ember-workflow": "^14.6.0"
   },
   "dependenciesMeta": {
     "@projectcaluma/ember-core": {