@venizia/ardor 0.1.1-0

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.
Files changed (7) hide show
  1. package/LICENSE.md +97 -0
  2. package/README.md +66 -0
  3. package/dist/index.d.ts +4 -0
  4. package/dist/index.d.ts.map +1 -0
  5. package/dist/index.js +7 -0
  6. package/dist/index.js.map +1 -0
  7. package/package.json +136 -0
package/LICENSE.md ADDED
@@ -0,0 +1,97 @@
1
+ # ARDOR Framework License
2
+
3
+ ARDOR is a TypeScript frontend application framework built on [IGNIS](https://ignis.venizia.ai) and
4
+ [React](https://react.dev/).
5
+
6
+ ## MIT License
7
+
8
+ Copyright (c) 2025 VENIZIA Ltd. Co.
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+
28
+ ---
29
+
30
+ ## Packages
31
+
32
+ This monorepo contains the following packages, all licensed under MIT:
33
+
34
+ | Package | Description |
35
+ |---------|-------------|
36
+ | `@venizia/ardor` | Umbrella entry point over the framework packages |
37
+ | `@venizia/ardor-kernel` | Isomorphic core - application base, services, network layer, utilities |
38
+ | `@venizia/ardor-react` | React bindings - application context, injectable and UI hooks |
39
+ | `@venizia/ardor-admin` | react-admin adapter - data, auth and i18n providers |
40
+ | `@venizia/ardor-ui-kit` | Design system - Tailwind and Radix components, design tokens |
41
+
42
+ ---
43
+
44
+ ## Third-Party Dependencies
45
+
46
+ ARDOR uses the following open-source libraries. We are grateful to the authors and contributors of
47
+ these projects.
48
+
49
+ ### Core Dependencies
50
+
51
+ | Library | License | Description |
52
+ |---------|---------|-------------|
53
+ | [IGNIS](https://github.com/VENIZIA-AI/ignis) | MIT | Inversion of control container and query filter vocabulary |
54
+ | [React](https://github.com/facebook/react) | MIT | User interface library |
55
+ | [react-admin](https://github.com/marmelab/react-admin) (`ra-core`) | MIT | Admin application framework |
56
+ | [reflect-metadata](https://github.com/rbuckton/reflect-metadata) | Apache-2.0 | Metadata reflection API |
57
+
58
+ ### Data and State Dependencies
59
+
60
+ | Library | License | Description |
61
+ |---------|---------|-------------|
62
+ | [Redux Toolkit](https://github.com/reduxjs/redux-toolkit) | MIT | State container |
63
+ | [React Redux](https://github.com/reduxjs/react-redux) | MIT | React bindings for Redux |
64
+ | [TanStack Query](https://github.com/TanStack/query) | MIT | Asynchronous state management |
65
+ | [React Router](https://github.com/remix-run/react-router) | MIT | Routing |
66
+ | [Axios](https://github.com/axios/axios) | MIT | HTTP client |
67
+ | [Socket.IO Client](https://github.com/socketio/socket.io) | MIT | Real-time bidirectional communication |
68
+ | [Lodash](https://github.com/lodash/lodash) | MIT | Utility library |
69
+ | [node-polyglot](https://github.com/airbnb/polyglot.js) (`ra-i18n-polyglot`) | BSD-2-Clause | Internationalisation |
70
+
71
+ ### UI Kit Dependencies
72
+
73
+ | Library | License | Description |
74
+ |---------|---------|-------------|
75
+ | [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) | MIT | Utility-first CSS framework |
76
+ | [Radix UI](https://github.com/radix-ui/primitives) | MIT | Unstyled, accessible component primitives |
77
+ | [Lucide](https://github.com/lucide-icons/lucide) | ISC | Icon set |
78
+ | [Day.js](https://github.com/iamkun/dayjs) | MIT | Date manipulation library |
79
+
80
+ ---
81
+
82
+ ## Acknowledgments
83
+
84
+ ARDOR is inspired by and built upon the work of many open-source projects:
85
+
86
+ - **[IGNIS](https://ignis.venizia.ai)** - The backend framework ARDOR is the frontend sibling of
87
+ - **[react-admin](https://marmelab.com/react-admin/)** by Marmelab - The admin framework ARDOR adapts
88
+ - **[LoopBack 4](https://loopback.io/)** by IBM/StrongLoop - Inspiration for the binding-key and provider patterns
89
+ - **[shadcn/ui](https://ui.shadcn.com/)** - Inspiration and source for the UI kit component layer
90
+
91
+ We thank all the maintainers and contributors of these projects for their excellent work.
92
+
93
+ ---
94
+
95
+ ## Contributing
96
+
97
+ By contributing to ARDOR, you agree that your contributions will be licensed under the MIT License.
package/README.md ADDED
@@ -0,0 +1,66 @@
1
+ # @venizia/ardor
2
+
3
+ Frontend application framework for the VENIZIA family - one entry point over
4
+ [`@venizia/ardor-kernel`](https://www.npmjs.com/package/@venizia/ardor-kernel),
5
+ [`@venizia/ardor-react`](https://www.npmjs.com/package/@venizia/ardor-react) and
6
+ [`@venizia/ardor-admin`](https://www.npmjs.com/package/@venizia/ardor-admin).
7
+
8
+ IGNIS is the backend framework; ARDOR is its frontend sibling and a consumer of it - inversion of
9
+ control comes from `@venizia/ignis-inversion`, and the data layer speaks the query vocabulary of
10
+ `@venizia/ignis-filter`.
11
+
12
+ ```bash
13
+ bun add @venizia/ardor @venizia/ignis-inversion @venizia/ignis-filter reflect-metadata
14
+ ```
15
+
16
+ ## Quick start
17
+
18
+ ```typescript
19
+ import 'reflect-metadata';
20
+
21
+ import {
22
+ BaseArdorApplication,
23
+ CoreBindings,
24
+ DefaultAuthProvider,
25
+ DefaultAuthService,
26
+ DefaultI18nProvider,
27
+ DefaultRestDataProvider,
28
+ type IApplicationInfo,
29
+ } from '@venizia/ardor';
30
+
31
+ export class Application extends BaseArdorApplication {
32
+ getAppInfo(): IApplicationInfo {
33
+ return { name: 'seller', version: '1.0.0', description: 'Seller console' };
34
+ }
35
+
36
+ bindContext(): void {
37
+ this.bind({ key: CoreBindings.REST_DATA_PROVIDER_OPTIONS }).toValue({
38
+ url: import.meta.env.VITE_API_URL,
39
+ noAuthPaths: ['/auth/login'],
40
+ });
41
+ this.bind({ key: CoreBindings.AUTH_PROVIDER_OPTIONS }).toValue({
42
+ paths: { signIn: '/auth/login' },
43
+ endpoints: { afterLogin: '/dashboard' },
44
+ });
45
+ this.bind({ key: CoreBindings.I18N_PROVIDER_OPTIONS }).toValue({});
46
+
47
+ this.bind({ key: CoreBindings.DEFAULT_REST_DATA_PROVIDER }).toProvider(DefaultRestDataProvider);
48
+ this.bind({ key: CoreBindings.DEFAULT_AUTH_SERVICE }).toClass(DefaultAuthService);
49
+ this.bind({ key: CoreBindings.DEFAULT_AUTH_PROVIDER }).toProvider(DefaultAuthProvider);
50
+ this.bind({ key: CoreBindings.DEFAULT_I18N_PROVIDER }).toProvider(DefaultI18nProvider);
51
+ }
52
+ }
53
+ ```
54
+
55
+ The full guide, including the root component and the typed hooks, is in the
56
+ [repository README](https://github.com/VENIZIA-AI/ardor#readme).
57
+
58
+ ## Migrating from `@minimaltech/ra-core-infra`
59
+
60
+ ARDOR is that package, split and rebranded. See
61
+ [the migration guide](https://github.com/VENIZIA-AI/ardor/blob/develop/docs/migration/ra-core-infra.md) -
62
+ the move is four mechanical edits plus four symbol renames.
63
+
64
+ ## License
65
+
66
+ MIT - see [LICENSE.md](./LICENSE.md).
package/dist/index.d.ts ADDED
@@ -0,0 +1,4 @@
1
+ export * from '@venizia/ardor-kernel';
2
+ export * from '@venizia/ardor-react';
3
+ export * from '@venizia/ardor-admin';
4
+ //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,7 @@
1
+ // ARDOR - one entry point over the framework packages.
2
+ // An application imports from `@venizia/ardor`; a consumer that needs only one layer installs that
3
+ // package directly.
4
+ export * from '@venizia/ardor-kernel';
5
+ export * from '@venizia/ardor-react';
6
+ export * from '@venizia/ardor-admin';
7
+ //# sourceMappingURL=index.js.map
package/dist/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,mGAAmG;AACnG,oBAAoB;AACpB,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC"}
package/package.json ADDED
@@ -0,0 +1,136 @@
1
+ {
2
+ "name": "@venizia/ardor",
3
+ "version": "0.1.1-0",
4
+ "description": "ARDOR - frontend application framework for the VENIZIA family. One entry point over ardor-kernel, ardor-react and ardor-admin: IGNIS inversion of control, a REST data layer, auth and i18n providers, and the React bindings for a react-admin application.",
5
+ "keywords": [
6
+ "ardor",
7
+ "dependency-injection",
8
+ "framework",
9
+ "frontend",
10
+ "ignis",
11
+ "inversion-of-control",
12
+ "ra-core",
13
+ "react",
14
+ "react-admin",
15
+ "rest",
16
+ "spa",
17
+ "typescript",
18
+ "venizia"
19
+ ],
20
+ "homepage": "https://ardor.venizia.ai",
21
+ "repository": {
22
+ "type": "git",
23
+ "url": "git+https://github.com/VENIZIA-AI/ardor.git",
24
+ "directory": "packages/ardor"
25
+ },
26
+ "bugs": {
27
+ "url": "https://github.com/VENIZIA-AI/ardor/issues"
28
+ },
29
+ "author": {
30
+ "name": "VENIZIA AI Developer",
31
+ "email": "developer@venizia.ai",
32
+ "url": "https://venizia.ai"
33
+ },
34
+ "license": "MIT",
35
+ "engines": {
36
+ "bun": ">=1.3"
37
+ },
38
+ "type": "module",
39
+ "main": "./dist/index.js",
40
+ "module": "./dist/index.js",
41
+ "types": "./dist/index.d.ts",
42
+ "exports": {
43
+ ".": {
44
+ "types": "./dist/index.d.ts",
45
+ "import": "./dist/index.js",
46
+ "default": "./dist/index.js"
47
+ },
48
+ "./package.json": "./package.json"
49
+ },
50
+ "sideEffects": false,
51
+ "files": [
52
+ "README.md",
53
+ "LICENSE.md",
54
+ "dist",
55
+ "!/**/__tests__",
56
+ "!**/*.tsbuildinfo"
57
+ ],
58
+ "publishConfig": {
59
+ "access": "public"
60
+ },
61
+ "scripts": {
62
+ "force-update": "sh ./scripts/force-update.sh",
63
+ "build": "sh ./scripts/build.sh",
64
+ "typecheck": "tsc --noEmit -p tsconfig.json",
65
+ "clean": "sh ./scripts/clean.sh",
66
+ "eslint": "eslint --report-unused-disable-directives .",
67
+ "lint": "bun run eslint && bun run prettier:cli",
68
+ "lint:fix": "bun run eslint --fix && bun run prettier:fix",
69
+ "prettier:cli": "prettier \"**/*.{js,ts,tsx}\" -l",
70
+ "prettier:fix": "bun run prettier:cli --write",
71
+ "rebuild": "sh ./scripts/rebuild.sh no-version",
72
+ "prepublishOnly": "bun run rebuild",
73
+ "size": "size-limit"
74
+ },
75
+ "dependencies": {
76
+ "@venizia/ardor-admin": "^0.1.1-0",
77
+ "@venizia/ardor-kernel": "^0.1.1-0",
78
+ "@venizia/ardor-react": "^0.1.1-0"
79
+ },
80
+ "peerDependencies": {
81
+ "@reduxjs/toolkit": ">=2.12.0",
82
+ "@tanstack/react-query": ">=5.101.2",
83
+ "@venizia/ignis-filter": "^0.2.0-7",
84
+ "@venizia/ignis-inversion": "^0.2.0-7",
85
+ "ra-core": ">=5.15.0",
86
+ "react": ">=18.0",
87
+ "react-dom": ">=18.0",
88
+ "react-redux": ">=9.3.0",
89
+ "react-router-dom": ">=7.9.4",
90
+ "reflect-metadata": ">=0.2.2"
91
+ },
92
+ "devDependencies": {
93
+ "@reduxjs/toolkit": "catalog:",
94
+ "@size-limit/preset-small-lib": "catalog:",
95
+ "@tanstack/react-query": "catalog:",
96
+ "@types/bun": "catalog:",
97
+ "@types/react": "catalog:",
98
+ "@types/react-dom": "catalog:",
99
+ "@venizia/dev-configs": "catalog:",
100
+ "@venizia/ignis-filter": "^0.2.0-7",
101
+ "@venizia/ignis-inversion": "^0.2.0-7",
102
+ "eslint": "catalog:",
103
+ "prettier": "catalog:",
104
+ "ra-core": "catalog:",
105
+ "react": "catalog:",
106
+ "react-dom": "catalog:",
107
+ "react-redux": "catalog:",
108
+ "react-router-dom": "catalog:",
109
+ "reflect-metadata": "catalog:",
110
+ "size-limit": "catalog:",
111
+ "tsc-alias": "catalog:",
112
+ "typescript": "catalog:"
113
+ },
114
+ "size-limit": [
115
+ {
116
+ "path": "dist/index.js",
117
+ "import": "*",
118
+ "ignore": [
119
+ "@reduxjs/toolkit",
120
+ "@tanstack/react-query",
121
+ "@venizia/ardor-admin",
122
+ "@venizia/ardor-kernel",
123
+ "@venizia/ardor-react",
124
+ "@venizia/ignis-filter",
125
+ "@venizia/ignis-inversion",
126
+ "ra-core",
127
+ "react",
128
+ "react-dom",
129
+ "react-redux",
130
+ "react-router-dom",
131
+ "reflect-metadata"
132
+ ],
133
+ "limit": "250 B"
134
+ }
135
+ ]
136
+ }