1.7.4 • Published 7 months ago

edifice-ts-client v1.7.4

Weekly downloads
-
License
AGPL-3.0
Repository
github
Last release
7 months ago

Edifice TS Client

Edifice TS Client exposes frameworks for interacting with entcore-based servers APIs. It is written in typescript, with minimal dependencies (rxjs and axios at the moment).

Prerequisites

  • pnpm: >= 7 | 8
  • node: >= 16 | 18

Getting Started

pnpm install

Build

pnpm run build

Documentation

As rule of thumb, edifice-ts-client never uses any browser-related technology (no HTMLElement, Document, navigator...). It focus exclusively on data exchange with the servers.

  • IConfigurationFramework is composed of 3 layers

    • Platform (apps, theme, analytics, i18n...)
    • School
    • User (preferences)

  • ISession of the connected user

    • user
    • description
    • currentLanguage
    • notLoggedIn
    • avatarUrl
    • currentApp (the one which initialized the framework)
    • hasWorkflow
    • hasRight

  • INotifyFramework for async messages

    • onLangReady
    • onSessionReady
    • onSkinReady
    • onOverridesReady
    • promisify (generic for creating/resolving/rejecting a Promise)
    • events (a publish/subscribe event broker)

  • ITransportFramework wraps the HTTP protocol

  • IExplorerFramework to look for resources

  • IWidgetFramework dedicated to widgets conf/prefs

  • and specific app frameworks for modeling their data

Browse the full API documentation here

Additional developers notes

4 additional libs are installed by the pnpm install command.

  • ViteJS as a Bundler
  • Typedoc to generate the markdown documentation, in /docs, from the Typescript comments in source code.
  • husky to install a local git pre-commit hook, in order to run the unit-tests and update /docs before every commit. => /docs will always be up-to-date on the git server.

The pnpm run build command will populate the /dist directory

  • /dist/ts contains the JS code and associated .d.ts and .js.map files, later packaged in NPM (done by our CI).
  • /dist/bundle contains the production-ready code/map.

So, you'll just have to write nice documented code, and unit tests where needed !

Push Force

git push --force is not recommended!

After a git history rewrite due to a git push --force, the git tags and notes referencing the commits that were rewritten are lost.

If it happens, read this troubleshooting section: Troubleshooting

axioscore-js
@everything-registry/sub-chunk-1554
1.7.4-develop-integration.20241211183523

7 months ago

1.7.4-develop-integration.20241211182452

7 months ago

1.7.4

7 months ago

1.7.3-develop-b2school.20241203173247

7 months ago

1.7.4-develop-integration.20241210145142

7 months ago

1.7.4-develop-b2school.20241204163938

7 months ago

1.7.3-develop-integration.20241204102020

7 months ago

1.7.4-develop-integration.20241210144836

7 months ago

1.7.3-develop-integration.20241204155819

7 months ago

1.7.4-hotfix-attachment

7 months ago

1.7.4-develop-integration.20241210115714

7 months ago

1.7.3-develop-integration.20241204162723

7 months ago

1.7.3-develop-pedago.20241203173637

7 months ago

1.7.4-develop-integration.20241211184452

7 months ago

1.7.4-develop-integration.20241211182822

7 months ago

1.7.4-develop-pedago.20241204164303

7 months ago

1.7.3

7 months ago

1.7.4-develop-integration.20241204165439

7 months ago

1.7.2-hotfix.0

8 months ago

1.7.2-hotfix.1

8 months ago

1.7.2-hotfix.2

8 months ago

1.7.2-hotfix.3

8 months ago

1.7.1-develop.20241128153332

8 months ago

1.7.2

8 months ago

1.6.0-develop-pedago.20241120164949

8 months ago

1.7.1-develop-b2school.20241126184347

8 months ago

1.6.0-develop-pedago.20241121111837

8 months ago

1.6.0-develop-b2school.20241120165153

8 months ago

1.6.0-develop-docker.20241120162649

8 months ago

1.7.1-develop.20241126145018

8 months ago

1.6.0-develop-b2school.20241121111643

8 months ago

1.6.0-develop-integration.20241120165425

8 months ago

1.7.0

8 months ago

1.6.0-develop.20241121110356

8 months ago

1.7.1-develop-hotfix.1732538183531

8 months ago

1.6.0

8 months ago

1.6.1-develop-pedago.1731942746661

8 months ago

1.6.0-develop-b2school.11

8 months ago

1.6.0-develop.7

8 months ago

1.6.0-develop.8

8 months ago

1.6.0-develop.9

8 months ago

1.6.0-develop-b2school.10

8 months ago

1.5.20-develop-integration.4

8 months ago

1.5.20-develop-integration.6

8 months ago

1.6.0-develop-b2school.9

8 months ago

1.6.0-develop-b2school.7

8 months ago

1.6.0-develop-b2school.5

8 months ago

1.6.0-develop-b2school.4

8 months ago

1.6.0-develop.15

8 months ago

1.6.0-develop.13

8 months ago

1.6.0-develop.10

8 months ago

1.6.0-develop.4

9 months ago

1.6.0-develop.5

9 months ago

1.5.23

9 months ago

1.6.0-develop-b2school.3

9 months ago

1.6.0-develop-b2school.2

9 months ago

1.5.23-hotfix-check-user-rights.1

9 months ago

1.6.0-develop.0

9 months ago

1.6.0-develop.1

9 months ago

1.5.22-develop-pedago.12

9 months ago

1.5.22-develop-pedago.13

9 months ago

1.5.22

9 months ago

1.5.22-develop.0

9 months ago

2.0.0-develop-rc.13

9 months ago

1.5.18-develop-pedago.9

10 months ago

1.5.18-develop-pedago.6

10 months ago

1.5.18-develop-pedago.5

10 months ago

1.5.20-develop-pedago.0

10 months ago

1.5.19-develop-b2school.0

10 months ago

1.5.19-develop-b2school.1

10 months ago

1.5.20-develop-b2school.0

10 months ago

1.5.18-develop-integration.1

11 months ago

1.5.18-develop-integration.0

11 months ago

1.5.19-develop.3

10 months ago

1.5.19-develop.2

10 months ago

1.5.19-develop.1

10 months ago

1.5.22-develop-pedago.0

9 months ago

1.5.19-develop.0

10 months ago

1.5.22-hotfix-editor.3

9 months ago

1.5.22-develop-pedago.1

9 months ago

1.5.22-hotfix-editor.0

9 months ago

1.5.22-hotfix-editor.1

9 months ago

1.5.22-hotfix-editor.2

9 months ago

1.5.20-develop.0

10 months ago

1.5.19-develop-integration.0

10 months ago

1.5.20-develop-integration.0

10 months ago

1.5.18-develop.5

10 months ago

1.5.18-develop.6

10 months ago

1.5.20-develop-integration.2

9 months ago

1.5.20-develop-integration.1

10 months ago

2.0.0-develop-rc.0

10 months ago

1.5.20-develop-integration.3

9 months ago

1.5.19-develop-pedago.2

10 months ago

1.5.19-develop-pedago.0

10 months ago

1.5.21-develop.0

9 months ago

1.5.19

10 months ago

1.5.18-develop-pedago.2

10 months ago

1.5.18-develop-pedago.1

10 months ago

1.5.21

9 months ago

1.5.17-develop-integration.3

11 months ago

1.5.17-develop.0

11 months ago

1.5.17-develop.1

11 months ago

1.5.16-develop-integration.0

11 months ago

1.5.16-develop-rc.0

11 months ago

1.5.17

11 months ago

1.5.18-develop-pedago.0

11 months ago

1.5.17-develop-integration.2

11 months ago

1.5.17-develop-integration.0

11 months ago

1.5.16-develop.0

12 months ago

1.5.16

12 months ago

1.5.15

12 months ago

1.5.15-develop.2

12 months ago

1.5.15-develop.0

12 months ago

1.5.15-develop-wl.1

12 months ago

1.5.15-develop-pedago.14

12 months ago

1.5.15-develop-pedago.15

12 months ago

1.5.15-develop-pedago.11

12 months ago

1.5.10-develop-integration.0

1 year ago

1.5.10-develop.5

1 year ago

1.5.10-develop.2

1 year ago

1.5.10-develop.1

1 year ago

1.5.10-develop.4

1 year ago

1.5.10-develop.3

1 year ago

1.5.10-develop-b2school.19

1 year ago

1.5.10-develop-b2school.22

1 year ago

1.5.10-develop-b2school.21

1 year ago

1.5.10-develop-b2school.20

1 year ago

1.5.15-develop-pedago.0

12 months ago

1.5.15-develop-pedago.5

12 months ago

1.5.15-develop-pedago.6

12 months ago

1.5.15-develop-pedago.7

12 months ago

1.5.12-develop-mozo.1

1 year ago

1.5.11-develop-b2school.5

1 year ago

1.5.11-develop-b2school.3

1 year ago

1.5.12-develop-pedago.0

1 year ago

1.5.12-develop-pedago.4

1 year ago

1.5.12-develop-pedago.5

1 year ago

1.5.12-develop-pedago.3

1 year ago

1.5.14-develop-integration.0

1 year ago

1.5.12-develop-integration.1

1 year ago

1.5.9-develop-integration.0

1 year ago

1.5.15-develop-wl.0

12 months ago

1.5.11-develop-pedago.1

1 year ago

1.5.11-develop-pedago.3

1 year ago

1.5.11-develop-pedago.4

1 year ago

1.5.11-develop-pedago.6

1 year ago

1.5.11-develop-pedago.8

1 year ago

1.5.15-develop-hotfix.1

12 months ago

1.5.11-hotfix.1

1 year ago

1.5.11-hotfix.0

1 year ago

1.5.15-develop-hotfix.0

12 months ago

1.5.14-develop.0

1 year ago

1.5.10-develop-pedago.3

1 year ago

1.5.10-develop-pedago.1

1 year ago

1.5.15-develop-b2school.2

12 months ago

1.5.15-develop-b2school.1

12 months ago

1.5.10-develop-pedago.4

1 year ago

1.5.12-develop.1

1 year ago

1.5.10

1 year ago

1.5.12

1 year ago

1.5.11

1 year ago

1.5.14

1 year ago

1.5.13

1 year ago

1.5.14-develop-pedago.0

1 year ago

1.5.13-develop.1

1 year ago

1.5.9-develop-b2school.8

1 year ago

1.5.10-develop-b2school.0

1 year ago

1.5.10-develop-pedago.0

1 year ago

1.5.9

1 year ago

1.5.9-develop.2

1 year ago

1.5.9-develop.0

1 year ago

1.5.9-develop.1

1 year ago

1.5.9-develop-b2school.0

1 year ago

1.5.8-develop-b2school.1

1 year ago

1.5.9-develop-b2school.2

1 year ago

1.5.9-develop-b2school.3

1 year ago

1.5.9-develop-pedago.0

1 year ago

1.5.8-develop.1

1 year ago

1.5.8-develop.0

1 year ago

1.5.8

1 year ago

1.5.4-develop-b2school.32

1 year ago

1.5.8-develop-pedago.0

1 year ago

1.5.7

1 year ago

1.5.4-develop.23

1 year ago

1.5.5

1 year ago

1.5.4-develop-pedago.11

1 year ago

1.5.4-develop-b2school.26

1 year ago

1.5.4-develop-integration.17

1 year ago

1.5.4-develop-b2school.23

1 year ago

1.5.4-develop.18

1 year ago

1.5.4-develop.17

1 year ago

1.5.4-develop.16

1 year ago

1.5.4-develop.14

1 year ago

1.5.4-develop.13

1 year ago

1.5.4-develop.8

1 year ago

1.5.4-develop.9

1 year ago

1.5.4-develop.11

1 year ago

1.5.4-develop-integration.7

1 year ago

1.5.4-develop-integration.6

1 year ago

1.5.4-develop-b2school.21

1 year ago

1.5.4-develop-b2school.15

1 year ago

1.5.4

1 year ago

1.5.4-develop.7

1 year ago

1.5.4-develop-b2school.11

1 year ago

1.5.4-develop-integration.4

1 year ago

1.5.4-develop-integration.3

1 year ago

1.5.0-develop-pedago.1

1 year ago

1.4.0-develop-pedago.3

1 year ago

1.5.4-develop-integration.0

1 year ago

1.5.4-develop-integration.2

1 year ago

1.5.4-develop-integration.1

1 year ago

1.5.0-develop.2

1 year ago

1.5.0-develop.1

1 year ago

1.5.4-develop.0

1 year ago

1.5.4-develop.2

1 year ago

1.4.0

1 year ago

1.4.0-develop-pedago.2

1 year ago

1.4.0-develop-pedago.1

1 year ago

1.4.0-develop.1

1 year ago

1.4.0-develop-b2school.12

1 year ago

1.3.0-develop-pedago.4

1 year ago

1.4.0-develop-b2school.11

1 year ago

1.4.0-develop-b2school.10

1 year ago

1.3.1-develop-integration.1

1 year ago

1.4.0-develop-b2school.9

1 year ago

1.4.0-develop-b2school.8

1 year ago

1.4.0-develop-b2school.7

1 year ago

1.3.0-develop-pedago.3

1 year ago

1.4.0-develop-b2school.6

1 year ago

1.4.0-develop-b2school.5

1 year ago

1.4.0-develop-b2school.4

1 year ago

1.4.0-develop-b2school.3

1 year ago

1.4.0-develop-b2school.1

1 year ago

1.4.0-develop-b2school.2

1 year ago

1.3.0-develop-pedago.2

1 year ago

1.3.1-develop-b2school.1

1 year ago

1.3.0

1 year ago

1.3.0-develop.2

1 year ago

1.3.0-develop.1

1 year ago

1.2.0

1 year ago

1.3.0-develop-pedago.1

1 year ago

1.2.1-develop-b2school.1

1 year ago

1.2.0-develop-pedago.7

1 year ago

1.2.0-develop-b2school.1

1 year ago

1.2.0-develop.3

1 year ago

1.2.0-develop.4

1 year ago

1.1.1-develop-b2school.3

1 year ago

1.2.0-develop-pedago.6

1 year ago

1.2.0-develop.1

1 year ago

1.2.0-develop.2

1 year ago

1.2.0-develop-pedago.5

1 year ago

1.2.0-develop-pedago.4

1 year ago

1.2.0-develop-pedago.3

1 year ago

1.2.0-develop-pedago.2

1 year ago

1.1.1-develop-b2school.2

1 year ago

1.1.1

1 year ago

1.1.1-develop.1

1 year ago

1.1.1-develop-b2school.1

1 year ago

1.2.0-develop-pedago.1

1 year ago

1.1.0-develop-pedago.4

1 year ago

1.1.0

1 year ago

1.1.0-develop-pedago.3

1 year ago

1.1.0-develop-pedago.2

1 year ago

1.1.0-develop.10

1 year ago

1.1.0-develop.9

1 year ago

1.1.0-develop.7

1 year ago

1.1.0-develop.8

1 year ago

1.1.0-develop.6

1 year ago

1.1.0-develop-b2school.19

1 year ago

1.1.0-develop.5

1 year ago

1.1.0-develop.3

1 year ago

1.1.0-develop.4

1 year ago

1.1.0-develop.2

1 year ago

1.1.0-develop-pedago.1

2 years ago

1.1.0-develop.1

2 years ago

1.0.5-develop-pedago.2

2 years ago

1.1.0-develop-b2school.18

2 years ago

1.1.0-develop-b2school.17

2 years ago

1.1.0-develop-b2school.16

2 years ago

1.1.0-develop-b2school.15

2 years ago

1.1.0-develop-b2school.14

2 years ago

1.0.3-develop-pedago.4

2 years ago

1.0.3-develop-pedago.3

2 years ago

1.0.3-develop.1

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.1.0-develop-b2school.12

2 years ago

1.1.0-develop-b2school.13

2 years ago

1.1.0-develop-b2school.10

2 years ago

1.1.0-develop-b2school.11

2 years ago

1.0.5-develop-pedago.1

2 years ago

1.1.0-develop-b2school.6

2 years ago

1.1.0-develop-b2school.5

2 years ago

1.1.0-develop-b2school.4

2 years ago

1.1.0-develop-b2school.9

2 years ago

1.1.0-develop-b2school.8

2 years ago

1.1.0-develop-b2school.7

2 years ago

1.0.5-develop.1

2 years ago

1.0.4-develop.1

2 years ago

1.0.4-develop-pedago.1

2 years ago

1.0.2

2 years ago

1.0.1-develop.1

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

1.0.1-develop.2

2 years ago

1.0.3-develop-pedago.2

2 years ago

1.0.3-develop-pedago.1

2 years ago

1.0.0-develop-pedago.9

2 years ago

1.0.0-develop-pedago.8

2 years ago

1.0.0-develop-pedago.7

2 years ago

1.0.0-develop-pedago.6

2 years ago

1.0.0-develop-pedago.13

2 years ago

1.0.0-develop-pedago.14

2 years ago

1.0.0-develop-pedago.11

2 years ago

1.0.0-develop-pedago.12

2 years ago

1.0.0-develop-pedago.10

2 years ago

1.1.0-develop-b2school.3

2 years ago

1.0.1-develop-pedago.3

2 years ago

1.0.1-develop-pedago.2

2 years ago

1.0.1-develop-pedago.1

2 years ago

1.0.0-develop.10

2 years ago

1.0.0-develop-b2school.5

2 years ago

1.0.0-develop-b2school.4

2 years ago

1.1.0-develop-b2school.2

2 years ago

1.1.0-develop-b2school.1

2 years ago

1.0.0-develop-b2school.6

2 years ago

1.0.0-develop.9

2 years ago

1.0.0-develop-b2school.3

2 years ago

1.0.0-develop-pedago.5

2 years ago

1.0.0-develop.8

2 years ago

1.0.0-develop-pedago.4

2 years ago

1.0.0-develop.7

2 years ago

1.0.0-develop-pedago.3

2 years ago

1.0.0-develop.6

2 years ago

1.0.0-develop-pedago.2

2 years ago

1.0.0-develop-b2school.2

2 years ago

1.0.0-develop.5

2 years ago

1.0.0-develop.4

2 years ago

1.0.0-develop.3

2 years ago

1.0.0-develop.2

2 years ago

1.0.0-develop-pedago.1

2 years ago

1.0.0-develop-b2school.1

2 years ago

1.0.0-develop.1

2 years ago