From bc76ae83b5ca47c11d306307bed474d468d4956f Mon Sep 17 00:00:00 2001 From: Teresa Lazarini Date: Tue, 15 Oct 2024 17:16:48 -0300 Subject: [PATCH 1/3] feat: add descrption to packages configs --- packages/blueberry/package.json | 2 +- packages/br-addons/package.json | 2 +- packages/client-core/lib/FireboltFormEngine.ts | 1 - packages/client-core/package.json | 2 +- packages/client/package.json | 2 +- .../src/components/FireboltProvider/FireboltProvider.test.tsx | 3 +-- .../src/components/FireboltProvider/hook/useRequestsErrors.ts | 1 - packages/entities/package.json | 2 +- packages/material-theme/package.json | 2 +- packages/validators/package.json | 2 +- 10 files changed, 8 insertions(+), 11 deletions(-) delete mode 100644 packages/client/src/components/FireboltProvider/hook/useRequestsErrors.ts diff --git a/packages/blueberry/package.json b/packages/blueberry/package.json index 85228ccd..8d63a791 100644 --- a/packages/blueberry/package.json +++ b/packages/blueberry/package.json @@ -1,7 +1,7 @@ { "name": "@iq-firebolt/blueberry-theme", "version": "0.9.0", - "description": "> TODO: description", + "description": "Blueberry theme for firebolt", "author": "iq team", "homepage": "https://github.com/IQ-tech/firebolt#readme", "license": "Apache-2.0", diff --git a/packages/br-addons/package.json b/packages/br-addons/package.json index 261de784..d003c809 100644 --- a/packages/br-addons/package.json +++ b/packages/br-addons/package.json @@ -1,7 +1,7 @@ { "name": "@iq-firebolt/br-addons", "version": "0.9.0", - "description": "> TODO: description", + "description": "Firebolt br-addons package", "author": "iq team", "homepage": "https://github.com/IQ-tech/firebolt#readme", "license": "Apache-2.0", diff --git a/packages/client-core/lib/FireboltFormEngine.ts b/packages/client-core/lib/FireboltFormEngine.ts index e8cc6f1f..2fcd27a1 100644 --- a/packages/client-core/lib/FireboltFormEngine.ts +++ b/packages/client-core/lib/FireboltFormEngine.ts @@ -66,7 +66,6 @@ class FireboltFormEngine { const urlParams = getUrlParams() if (autofillData) { - //TODO to avaliate this.clearSession() } const sessionId = urlParams?.session_id diff --git a/packages/client-core/package.json b/packages/client-core/package.json index d721a363..648f9b77 100644 --- a/packages/client-core/package.json +++ b/packages/client-core/package.json @@ -1,7 +1,7 @@ { "name": "@iq-firebolt/client-core", "version": "0.9.0", - "description": "> TODO: description", + "description": "Firebolt Client Core", "author": "iq team", "homepage": "https://github.com/IQ-tech/firebolt#readme", "license": "Apache-2.0", diff --git a/packages/client/package.json b/packages/client/package.json index f3747294..7109e3e5 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -1,7 +1,7 @@ { "name": "@iq-firebolt/client", "version": "0.9.0", - "description": "> TODO: description", + "description": "Firebolt client", "author": "iq team", "homepage": "https://github.com/IQ-tech/firebolt#readme", "license": "Apache-2.0", diff --git a/packages/client/src/components/FireboltProvider/FireboltProvider.test.tsx b/packages/client/src/components/FireboltProvider/FireboltProvider.test.tsx index 3491a0af..16870413 100644 --- a/packages/client/src/components/FireboltProvider/FireboltProvider.test.tsx +++ b/packages/client/src/components/FireboltProvider/FireboltProvider.test.tsx @@ -69,7 +69,7 @@ describe("FireboltProvider component", () => { }) await waitForNextUpdate() - expect(result.current.stagedStep.data.fields).toEqual(secondStepData) + expect(result?.current?.stagedStep?.data.fields).toEqual(secondStepData) act(() => { result.current.commitStepChange() @@ -121,5 +121,4 @@ describe("FireboltProvider component - testes relacionados ao modo de debug", () }) it.todo("to test addons") - // TODO: TEST }) diff --git a/packages/client/src/components/FireboltProvider/hook/useRequestsErrors.ts b/packages/client/src/components/FireboltProvider/hook/useRequestsErrors.ts deleted file mode 100644 index 96fe79a1..00000000 --- a/packages/client/src/components/FireboltProvider/hook/useRequestsErrors.ts +++ /dev/null @@ -1 +0,0 @@ -// TODO: waiting for the back part to create the functions \ No newline at end of file diff --git a/packages/entities/package.json b/packages/entities/package.json index ff459f5e..e02022da 100644 --- a/packages/entities/package.json +++ b/packages/entities/package.json @@ -1,7 +1,7 @@ { "name": "@iq-firebolt/entities", "version": "0.9.0", - "description": "> TODO: description", + "description": "Entities package for firebolt", "author": "iq team", "private": true, "homepage": "https://github.com/IQ-tech/firebolt#readme", diff --git a/packages/material-theme/package.json b/packages/material-theme/package.json index d763c95c..f8530cc4 100644 --- a/packages/material-theme/package.json +++ b/packages/material-theme/package.json @@ -1,7 +1,7 @@ { "name": "@iq-firebolt/material-theme", "version": "0.9.0", - "description": "> TODO: description", + "description": "Firebolt material-theme package", "author": "iq team", "homepage": "https://github.com/IQ-tech/firebolt#readme", "license": "Apache-2.0", diff --git a/packages/validators/package.json b/packages/validators/package.json index 8609dc76..b8e71340 100644 --- a/packages/validators/package.json +++ b/packages/validators/package.json @@ -1,7 +1,7 @@ { "name": "@iq-firebolt/validators", "version": "0.9.0", - "description": "> TODO: description", + "description": "Firebolt validators package", "author": "iq team", "homepage": "https://github.com/IQ-tech/firebolt#readme", "license": "Apache-2.0", From 44bbda12a3d2c10f222f86dbc417d8c9aab8c8d9 Mon Sep 17 00:00:00 2001 From: Teresa Lazarini Date: Tue, 15 Oct 2024 17:23:15 -0300 Subject: [PATCH 2/3] feat: add description on readme where needed --- packages/client-core/README.md | 4 ++-- packages/client/README.md | 5 +---- packages/client/src/components/FireboltForm/hook/index.ts | 4 ++-- 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/packages/client-core/README.md b/packages/client-core/README.md index 57374b87..be213429 100644 --- a/packages/client-core/README.md +++ b/packages/client-core/README.md @@ -1,11 +1,11 @@ # `client-core` -> TODO: description +This Firebolt package gather helpers, formatters and entities used to improve Firebolt forms experience. ## Usage ``` const clientCore = require('client-core'); -// TODO: DEMONSTRATE API + ``` diff --git a/packages/client/README.md b/packages/client/README.md index c4844622..ab1b6151 100644 --- a/packages/client/README.md +++ b/packages/client/README.md @@ -1,13 +1,10 @@ # `@iq-firebolt/client` -> TODO: descriptions - -change later +Client package for Firebolt. This package gathers the chore structure for FreboltForm, FireboltProvider, StepForm and Wizard components. ## Usage ``` const client = require('@iq-firebolt/client'); -// TODO: DEMONSTRATE API ``` diff --git a/packages/client/src/components/FireboltForm/hook/index.ts b/packages/client/src/components/FireboltForm/hook/index.ts index b1f691f3..40c7e45f 100644 --- a/packages/client/src/components/FireboltForm/hook/index.ts +++ b/packages/client/src/components/FireboltForm/hook/index.ts @@ -82,8 +82,8 @@ export default function useFireboltForm( const actionsChildData: IActionsChildData = { isFormValid, handleSubmit, - payload: formPayload, // #TODO - currentStep: 1, //#TODO + payload: formPayload, + currentStep: 1, } return { From f939bf71e38d5f09b9eca3e68a3da1f76d358c56 Mon Sep 17 00:00:00 2001 From: Teresa Lazarini Date: Tue, 15 Oct 2024 17:25:46 -0300 Subject: [PATCH 3/3] feat: delete entities package, since it was empty --- .vscode/settings.json | 1 - packages/entities/CHANGELOG.md | 64 -------------------- packages/entities/README.md | 11 ---- packages/entities/__tests__/entities.test.js | 8 --- packages/entities/lib/entities.js | 7 --- packages/entities/package.json | 28 --------- 6 files changed, 119 deletions(-) delete mode 100644 packages/entities/CHANGELOG.md delete mode 100644 packages/entities/README.md delete mode 100644 packages/entities/__tests__/entities.test.js delete mode 100644 packages/entities/lib/entities.js delete mode 100644 packages/entities/package.json diff --git a/.vscode/settings.json b/.vscode/settings.json index d71960f2..e727386a 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,7 +5,6 @@ "client-core", "validators", "lab", - "entities", "blueberry-theme", "material-theme", "json-schema", diff --git a/packages/entities/CHANGELOG.md b/packages/entities/CHANGELOG.md deleted file mode 100644 index 68579856..00000000 --- a/packages/entities/CHANGELOG.md +++ /dev/null @@ -1,64 +0,0 @@ -# Change Log - -All notable changes to this project will be documented in this file. -See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. - -# [0.9.0](https://github.com/IQ-tech/firebolt/compare/v0.8.2...v0.9.0) (2022-10-19) - -**Note:** Version bump only for package @iq-firebolt/entities - - - - - -# [0.8.0](https://github.com/IQ-tech/firebolt/compare/v0.7.0...v0.8.0) (2022-06-08) - -**Note:** Version bump only for package @iq-firebolt/entities - - - - - -# [0.7.0](https://github.com/IQ-tech/firebolt/compare/v0.6.0...v0.7.0) (2022-04-26) - -**Note:** Version bump only for package @iq-firebolt/entities - - - - - -# [0.6.0](https://github.com/IQ-tech/firebolt/compare/v0.5.0...v0.6.0) (2022-03-15) - -**Note:** Version bump only for package @iq-firebolt/entities - - - - - -# [0.5.0](https://github.com/IQ-tech/firebolt/compare/v0.4.1...v0.5.0) (2022-03-08) - -**Note:** Version bump only for package @iq-firebolt/entities - - - - - -# [0.4.0](https://github.com/IQ-tech/firebolt/compare/v0.3.5...v0.4.0) (2022-03-08) - -**Note:** Version bump only for package @iq-firebolt/entities - - - - - -## [0.3.5](https://github.com/IQ-tech/firebolt/compare/v0.3.3...v0.3.5) (2022-03-08) - -**Note:** Version bump only for package @iq-firebolt/entities - - - - - -## 0.3.4 (2022-03-08) - -**Note:** Version bump only for package @iq-firebolt/entities diff --git a/packages/entities/README.md b/packages/entities/README.md deleted file mode 100644 index 6fce90fa..00000000 --- a/packages/entities/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# `@iq-firebolt/entities` - -> TODO: description - -## Usage - -``` -const entities = require('@iq-firebolt/entities'); - -// TODO: DEMONSTRATE API -``` diff --git a/packages/entities/__tests__/entities.test.js b/packages/entities/__tests__/entities.test.js deleted file mode 100644 index 2c448f87..00000000 --- a/packages/entities/__tests__/entities.test.js +++ /dev/null @@ -1,8 +0,0 @@ -'use strict'; - -const entities = require('..'); - -/* describe('@iq-firebolt/entities', () => { - it('needs tests'); -}); - */ \ No newline at end of file diff --git a/packages/entities/lib/entities.js b/packages/entities/lib/entities.js deleted file mode 100644 index 0e07abdb..00000000 --- a/packages/entities/lib/entities.js +++ /dev/null @@ -1,7 +0,0 @@ -'use strict'; - -module.exports = entities; - -function entities() { - // TODO -} diff --git a/packages/entities/package.json b/packages/entities/package.json deleted file mode 100644 index e02022da..00000000 --- a/packages/entities/package.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "name": "@iq-firebolt/entities", - "version": "0.9.0", - "description": "Entities package for firebolt", - "author": "iq team", - "private": true, - "homepage": "https://github.com/IQ-tech/firebolt#readme", - "license": "Apache-2.0", - "main": "lib/entities.js", - "directories": { - "lib": "lib", - "test": "__tests__" - }, - "files": [ - "lib" - ], - "publishConfig": { - "access": "public" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/IQ-tech/firebolt.git" - }, - "scripts": {}, - "bugs": { - "url": "https://github.com/IQ-tech/firebolt/issues" - } -}