@wawjs/ngx-bos 22.0.0 → 22.0.2
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.
- package/AGENTS.md +23 -23
- package/README.md +105 -105
- package/RELEASES.md +41 -15
- package/ai/architecture.md +40 -40
- package/ai/code-style.md +33 -33
- package/ai/decisions/2026-06-02-browser-only-bos-spa.md +16 -16
- package/ai/decisions/2026-06-02-package-boundary.md +22 -22
- package/ai/decisions/2026-06-02-version-start.md +12 -12
- package/ai/decisions/index.md +7 -7
- package/ai/onboarding.md +19 -19
- package/ai/task-execution.md +35 -35
- package/ai/tooling.md +33 -33
- package/fesm2022/wawjs-ngx-bos.mjs +138 -98
- package/fesm2022/wawjs-ngx-bos.mjs.map +1 -1
- package/package.json +1 -1
- package/src/feature/file/file.component.html +1 -1
- package/src/feature/file/file.component.ts +236 -220
- package/src/feature/file/file.interface.ts +12 -12
- package/src/feature/file/file.service.ts +35 -34
- package/src/feature/file/pages/files/files.component.html +2 -2
- package/src/feature/file/pages/files/files.component.ts +117 -117
- package/src/feature/file/pages/files/files.routes.ts +9 -9
- package/src/feature/file/selectors/file/file-selector.component.html +2 -5
- package/src/feature/file/selectors/file/file-selector.component.ts +24 -27
- package/src/feature/user/guards/admins.guard.ts +22 -22
- package/src/feature/user/guards/authenticated.guard.ts +14 -14
- package/src/feature/user/guards/guest.guard.ts +14 -14
- package/src/feature/user/pages/clients/clients.component.ts +45 -45
- package/src/feature/user/pages/clients/clients.routes.ts +1 -1
- package/src/feature/user/pages/users/users.component.html +3 -2
- package/src/feature/user/pages/users/users.component.scss +12 -0
- package/src/feature/user/pages/users/users.component.ts +78 -45
- package/src/feature/user/pages/users/users.routes.ts +1 -1
- package/src/feature/user/selectors/user/user-selector.component.ts +17 -17
- package/src/feature/user/user.const.ts +3 -3
- package/src/feature/user/user.form.ts +54 -54
- package/src/feature/user/user.interface.ts +12 -12
- package/src/feature/user/user.service.ts +178 -176
- package/src/form-components/ace/ace.component.ts +210 -210
- package/src/form-components/button/button.component.ts +31 -31
- package/src/form-components/file/file.component.ts +91 -91
- package/src/form-components/form-bridge.interface.ts +27 -27
- package/src/form-components/index.ts +85 -85
- package/src/form-components/input/input.component.html +1 -0
- package/src/form-components/input/input.component.ts +31 -31
- package/src/form-components/select/select.component.html +2 -2
- package/src/form-components/select/select.component.ts +31 -31
- package/src/form-components/tinymce/tinymce.component.ts +221 -221
- package/src/ngx-bos.config.ts +55 -55
- package/src/pages/form/form.component.ts +86 -86
- package/src/pages/form/form.routes.ts +1 -1
- package/src/pages/forms/forms.component.ts +15 -15
- package/src/pages/forms/forms.routes.ts +1 -1
- package/src/pipes/phone.pipe.ts +17 -17
- package/src/public-api.ts +36 -36
- package/types/wawjs-ngx-bos.d.ts +13 -9
package/AGENTS.md
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
# @wawjs/ngx-bos Agent Guide
|
|
2
|
-
|
|
3
|
-
This package provides reusable Ngx BOS guidance and, later, reusable CRM/BOS APIs.
|
|
4
|
-
|
|
5
|
-
Read the package AI files before structural or workflow work:
|
|
6
|
-
|
|
7
|
-
```text
|
|
8
|
-
ai/onboarding.md
|
|
9
|
-
ai/architecture.md
|
|
10
|
-
ai/code-style.md
|
|
11
|
-
ai/task-execution.md
|
|
12
|
-
ai/tooling.md
|
|
13
|
-
ai/decisions/index.md
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Rules
|
|
17
|
-
|
|
18
|
-
- Ngx BOS is a browser-only Angular SPA.
|
|
19
|
-
- Do not add SSR, prerender, static SEO, or landing-page-first assumptions unless explicitly asked.
|
|
20
|
-
- Keep business-specific routes, roles, schemas, dashboards, environment values, integrations, and
|
|
21
|
-
workflow copy in the app.
|
|
22
|
-
- Export reusable APIs from `src/public-api.ts`.
|
|
23
|
-
- Consumers import from `@wawjs/ngx-bos`, never package internals.
|
|
1
|
+
# @wawjs/ngx-bos Agent Guide
|
|
2
|
+
|
|
3
|
+
This package provides reusable Ngx BOS guidance and, later, reusable CRM/BOS APIs.
|
|
4
|
+
|
|
5
|
+
Read the package AI files before structural or workflow work:
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
ai/onboarding.md
|
|
9
|
+
ai/architecture.md
|
|
10
|
+
ai/code-style.md
|
|
11
|
+
ai/task-execution.md
|
|
12
|
+
ai/tooling.md
|
|
13
|
+
ai/decisions/index.md
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Rules
|
|
17
|
+
|
|
18
|
+
- Ngx BOS is a browser-only Angular SPA.
|
|
19
|
+
- Do not add SSR, prerender, static SEO, or landing-page-first assumptions unless explicitly asked.
|
|
20
|
+
- Keep business-specific routes, roles, schemas, dashboards, environment values, integrations, and
|
|
21
|
+
workflow copy in the app.
|
|
22
|
+
- Export reusable APIs from `src/public-api.ts`.
|
|
23
|
+
- Consumers import from `@wawjs/ngx-bos`, never package internals.
|
package/README.md
CHANGED
|
@@ -1,105 +1,105 @@
|
|
|
1
|
-
# @wawjs/ngx-bos
|
|
2
|
-
|
|
3
|
-
Reusable Angular 22 contracts, services, guards, selectors, pages, and AI guidance for Ngx BOS CRM and business operating system applications.
|
|
4
|
-
|
|
5
|
-
Current package line: `22.0.
|
|
6
|
-
|
|
7
|
-
## App Contract
|
|
8
|
-
|
|
9
|
-
Ngx BOS apps are browser-only SPAs. They are not SSR, prerender, static SEO, or landing-page templates.
|
|
10
|
-
|
|
11
|
-
Business apps own:
|
|
12
|
-
|
|
13
|
-
- routes and layouts
|
|
14
|
-
- roles and permissions
|
|
15
|
-
- dashboards and workflows
|
|
16
|
-
- entity modules, schemas, tables, forms, and detail pages
|
|
17
|
-
- environment and API configuration
|
|
18
|
-
- branding and deployment values
|
|
19
|
-
|
|
20
|
-
Import reusable APIs from the package entry point — never from package internals:
|
|
21
|
-
|
|
22
|
-
```ts
|
|
23
|
-
import { UserService } from '@wawjs/ngx-bos';
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Installation
|
|
27
|
-
|
|
28
|
-
```sh
|
|
29
|
-
npm install @wawjs/ngx-bos
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
### Peer dependencies
|
|
33
|
-
|
|
34
|
-
Angular 22 (`@angular/common`, `@angular/cdk`, `@angular/core`, `@angular/forms`, `@angular/router`), the WAW platform packages (`@wawjs/ngx-core`, `@wawjs/ngx-crud`, `@wawjs/ngx-ace`, `@wawjs/ngx-fabric`, `@wawjs/ngx-form`, `@wawjs/ngx-http`, `@wawjs/ngx-tinymce`, `@wawjs/ngx-translate`, `@wawjs/ngx-ui`), and `libphonenumber-js`. See [package.json](package.json) for exact ranges.
|
|
35
|
-
|
|
36
|
-
## Configuration
|
|
37
|
-
|
|
38
|
-
Wire the package into your app's providers with `ngxBosProvide` (alias `provideNgxBos`). Every field is optional and falls back to `DEFAULT_NGX_BOS_CONFIG`.
|
|
39
|
-
|
|
40
|
-
```ts
|
|
41
|
-
import { ngxBosProvide } from '@wawjs/ngx-bos';
|
|
42
|
-
|
|
43
|
-
export const appConfig = {
|
|
44
|
-
providers: [
|
|
45
|
-
ngxBosProvide({
|
|
46
|
-
appId: environment.appId,
|
|
47
|
-
url: environment.url,
|
|
48
|
-
cdnUrl: 'https://cdn.webart.work',
|
|
49
|
-
roles: environment.roles,
|
|
50
|
-
userFields: environment.userFields ?? [],
|
|
51
|
-
userForm: environment.userForm ?? [],
|
|
52
|
-
signPath: '/sign',
|
|
53
|
-
profilePath: '/profile',
|
|
54
|
-
defaultUserThumb: 'assets/default.png',
|
|
55
|
-
}),
|
|
56
|
-
// ...other WAW providers
|
|
57
|
-
],
|
|
58
|
-
};
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
| Option | Default | Purpose |
|
|
62
|
-
| ------------------ | --------------------------- | ---------------------------------------------------------- |
|
|
63
|
-
| `appId` | `''` | Application id used for scoped user queries |
|
|
64
|
-
| `url` | `''` | API base URL, prefixed onto user thumbnails and requests |
|
|
65
|
-
| `cdnUrl` | `'https://cdn.webart.work'` | CDN base URL |
|
|
66
|
-
| `roles` | `[]` | Employee roles (`'admin'` is appended internally) |
|
|
67
|
-
| `userFields` | `[]` | Extra `user.data.*` fields initialized on each user |
|
|
68
|
-
| `userForm` | `[]` | Form component descriptors for the user form |
|
|
69
|
-
| `signPath` | `'/sign'` | Route to redirect to on logout |
|
|
70
|
-
| `profilePath` | `'/profile'` | Route for the signed-in user's profile / avatar link |
|
|
71
|
-
| `defaultUserThumb` | `'assets/default.png'` | Fallback avatar when the user has no thumbnail |
|
|
72
|
-
|
|
73
|
-
The resolved config is available through the `NGX_BOS_CONFIG` injection token.
|
|
74
|
-
|
|
75
|
-
## Exports
|
|
76
|
-
|
|
77
|
-
- **Config:** `ngxBosProvide` / `provideNgxBos`, `NGX_BOS_CONFIG`, `DEFAULT_NGX_BOS_CONFIG`, `NgxBosConfig`, `NGX_BOS_VERSION`
|
|
78
|
-
- **User / auth:** `UserService`, `User` interface, user const/form, `UserSelectorComponent`, `UserPreviewComponent`, `UsersComponent`, `ClientsComponent`
|
|
79
|
-
- **Guards:** `AuthenticatedGuard`, `GuestGuard`, `AdminsGuard`
|
|
80
|
-
- **File:** `FileSelectorComponent`, `FilesComponent`, file feature contracts
|
|
81
|
-
- **Form pages:** `FormComponent`, `FormsComponent`
|
|
82
|
-
- **Routes:** `usersRoutes`, `clientsRoutes`, `filesRoutes`, `formRoutes`, `formsRoutes`
|
|
83
|
-
- **Misc:** form components, `spider` icon, `phone` pipe
|
|
84
|
-
|
|
85
|
-
### Using package routes
|
|
86
|
-
|
|
87
|
-
```ts
|
|
88
|
-
import { usersRoutes, AdminsGuard } from '@wawjs/ngx-bos';
|
|
89
|
-
|
|
90
|
-
export const routes: Routes = [
|
|
91
|
-
{ path: 'users', canActivate: [AdminsGuard], children: usersRoutes },
|
|
92
|
-
];
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
## Building
|
|
96
|
-
|
|
97
|
-
From the workspace root:
|
|
98
|
-
|
|
99
|
-
```sh
|
|
100
|
-
npm run build:ngx-bos
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
## AI Guidance
|
|
104
|
-
|
|
105
|
-
Reusable package guidance ships under `ai/` and is available to consuming apps at `node_modules/@wawjs/ngx-bos/ai/`.
|
|
1
|
+
# @wawjs/ngx-bos
|
|
2
|
+
|
|
3
|
+
Reusable Angular 22 contracts, services, guards, selectors, pages, and AI guidance for Ngx BOS CRM and business operating system applications.
|
|
4
|
+
|
|
5
|
+
Current package line: `22.0.2`.
|
|
6
|
+
|
|
7
|
+
## App Contract
|
|
8
|
+
|
|
9
|
+
Ngx BOS apps are browser-only SPAs. They are not SSR, prerender, static SEO, or landing-page templates.
|
|
10
|
+
|
|
11
|
+
Business apps own:
|
|
12
|
+
|
|
13
|
+
- routes and layouts
|
|
14
|
+
- roles and permissions
|
|
15
|
+
- dashboards and workflows
|
|
16
|
+
- entity modules, schemas, tables, forms, and detail pages
|
|
17
|
+
- environment and API configuration
|
|
18
|
+
- branding and deployment values
|
|
19
|
+
|
|
20
|
+
Import reusable APIs from the package entry point — never from package internals:
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import { UserService } from '@wawjs/ngx-bos';
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Installation
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
npm install @wawjs/ngx-bos
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Peer dependencies
|
|
33
|
+
|
|
34
|
+
Angular 22 (`@angular/common`, `@angular/cdk`, `@angular/core`, `@angular/forms`, `@angular/router`), the WAW platform packages (`@wawjs/ngx-core`, `@wawjs/ngx-crud`, `@wawjs/ngx-ace`, `@wawjs/ngx-fabric`, `@wawjs/ngx-form`, `@wawjs/ngx-http`, `@wawjs/ngx-tinymce`, `@wawjs/ngx-translate`, `@wawjs/ngx-ui`), and `libphonenumber-js`. See [package.json](package.json) for exact ranges.
|
|
35
|
+
|
|
36
|
+
## Configuration
|
|
37
|
+
|
|
38
|
+
Wire the package into your app's providers with `ngxBosProvide` (alias `provideNgxBos`). Every field is optional and falls back to `DEFAULT_NGX_BOS_CONFIG`.
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
import { ngxBosProvide } from '@wawjs/ngx-bos';
|
|
42
|
+
|
|
43
|
+
export const appConfig = {
|
|
44
|
+
providers: [
|
|
45
|
+
ngxBosProvide({
|
|
46
|
+
appId: environment.appId,
|
|
47
|
+
url: environment.url,
|
|
48
|
+
cdnUrl: 'https://cdn.webart.work',
|
|
49
|
+
roles: environment.roles,
|
|
50
|
+
userFields: environment.userFields ?? [],
|
|
51
|
+
userForm: environment.userForm ?? [],
|
|
52
|
+
signPath: '/sign',
|
|
53
|
+
profilePath: '/profile',
|
|
54
|
+
defaultUserThumb: 'assets/default.png',
|
|
55
|
+
}),
|
|
56
|
+
// ...other WAW providers
|
|
57
|
+
],
|
|
58
|
+
};
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
| Option | Default | Purpose |
|
|
62
|
+
| ------------------ | --------------------------- | ---------------------------------------------------------- |
|
|
63
|
+
| `appId` | `''` | Application id used for scoped user queries |
|
|
64
|
+
| `url` | `''` | API base URL, prefixed onto user thumbnails and requests |
|
|
65
|
+
| `cdnUrl` | `'https://cdn.webart.work'` | CDN base URL |
|
|
66
|
+
| `roles` | `[]` | Employee roles (`'admin'` is appended internally) |
|
|
67
|
+
| `userFields` | `[]` | Extra `user.data.*` fields initialized on each user |
|
|
68
|
+
| `userForm` | `[]` | Form component descriptors for the user form |
|
|
69
|
+
| `signPath` | `'/sign'` | Route to redirect to on logout |
|
|
70
|
+
| `profilePath` | `'/profile'` | Route for the signed-in user's profile / avatar link |
|
|
71
|
+
| `defaultUserThumb` | `'assets/default.png'` | Fallback avatar when the user has no thumbnail |
|
|
72
|
+
|
|
73
|
+
The resolved config is available through the `NGX_BOS_CONFIG` injection token.
|
|
74
|
+
|
|
75
|
+
## Exports
|
|
76
|
+
|
|
77
|
+
- **Config:** `ngxBosProvide` / `provideNgxBos`, `NGX_BOS_CONFIG`, `DEFAULT_NGX_BOS_CONFIG`, `NgxBosConfig`, `NGX_BOS_VERSION`
|
|
78
|
+
- **User / auth:** `UserService`, `User` interface, user const/form, `UserSelectorComponent`, `UserPreviewComponent`, `UsersComponent`, `ClientsComponent`
|
|
79
|
+
- **Guards:** `AuthenticatedGuard`, `GuestGuard`, `AdminsGuard`
|
|
80
|
+
- **File:** `FileSelectorComponent`, `FilesComponent`, file feature contracts
|
|
81
|
+
- **Form pages:** `FormComponent`, `FormsComponent`
|
|
82
|
+
- **Routes:** `usersRoutes`, `clientsRoutes`, `filesRoutes`, `formRoutes`, `formsRoutes`
|
|
83
|
+
- **Misc:** form components, `spider` icon, `phone` pipe
|
|
84
|
+
|
|
85
|
+
### Using package routes
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
import { usersRoutes, AdminsGuard } from '@wawjs/ngx-bos';
|
|
89
|
+
|
|
90
|
+
export const routes: Routes = [
|
|
91
|
+
{ path: 'users', canActivate: [AdminsGuard], children: usersRoutes },
|
|
92
|
+
];
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Building
|
|
96
|
+
|
|
97
|
+
From the workspace root:
|
|
98
|
+
|
|
99
|
+
```sh
|
|
100
|
+
npm run build:ngx-bos
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## AI Guidance
|
|
104
|
+
|
|
105
|
+
Reusable package guidance ships under `ai/` and is available to consuming apps at `node_modules/@wawjs/ngx-bos/ai/`.
|
package/RELEASES.md
CHANGED
|
@@ -1,21 +1,47 @@
|
|
|
1
1
|
# Releases
|
|
2
2
|
|
|
3
|
-
## 22.0.
|
|
3
|
+
## 22.0.2
|
|
4
4
|
|
|
5
|
-
Angular 22 and WAW 22
|
|
5
|
+
Angular 22.0.8 and WAW 22.0.2 platform release.
|
|
6
6
|
|
|
7
|
-
- updates
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
|
|
13
|
-
|
|
7
|
+
- updates the reusable file upload and crop workflow, including its contracts, selector, and files page
|
|
8
|
+
- adds reusable WAW form-component adapters and form management pages
|
|
9
|
+
- adds reusable user/client administration pages, guards, selectors, and profile preview support
|
|
10
|
+
- fixes absolute user thumbnail URLs so they are not prefixed with the API base URL
|
|
11
|
+
- updates the Users page: compact role columns, direct admin role updates, and admin-safe user editing
|
|
12
|
+
- publishes the current package AI guidance and source assets for consumer apps
|
|
13
|
+
|
|
14
|
+
### Migration notes
|
|
14
15
|
|
|
15
|
-
|
|
16
|
+
- update all `@wawjs/*` dependencies together to the `22.0.2` platform line
|
|
17
|
+
- use `UserService.updateAdmin()` for administrative user edits; `update()` remains the signed-in user's profile update
|
|
16
18
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
-
|
|
19
|
+
## 22.0.1
|
|
20
|
+
|
|
21
|
+
Angular 22.0.4 and WAW 22.0.1 package update.
|
|
22
|
+
|
|
23
|
+
- bumps Angular and Angular CLI from 22.0.1 to 22.0.4
|
|
24
|
+
- bumps all `@wawjs/*` peer dependencies from 22.0.0 to 22.0.1
|
|
25
|
+
- bumps `ng-packagr` from 22.0.0 to 22.0.4
|
|
26
|
+
- migrates `FileService` from `@Injectable` to `@Service()`
|
|
27
|
+
- updates `NGX_BOS_VERSION` constant to `22.0.1`
|
|
28
|
+
|
|
29
|
+
## 22.0.0
|
|
30
|
+
|
|
31
|
+
Angular 22 and WAW 22 package update.
|
|
32
|
+
|
|
33
|
+
- updates Angular, Angular CLI, ng-packagr, TypeScript, and WAW package peers to the 22.x line
|
|
34
|
+
- switches app integrations to WAW Ace, TinyMCE, and socket providers
|
|
35
|
+
- removes explicit `ChangeDetectionStrategy.OnPush` from components because Angular 22 uses OnPush by default
|
|
36
|
+
- documents `ChangeDetectionStrategy.Eager` as the explicit opt-in for eager change detection
|
|
37
|
+
- keeps translate migration out of this release scope
|
|
38
|
+
|
|
39
|
+
## 21.0.0
|
|
40
|
+
|
|
41
|
+
Initial Ngx BOS package scaffold.
|
|
42
|
+
|
|
43
|
+
- adds package metadata for `@wawjs/ngx-bos`
|
|
44
|
+
- adds empty public API surface for future reusable BOS code
|
|
45
|
+
- adds package-published AI guidance
|
|
46
|
+
- establishes browser-only CRM/BOS SPA rules
|
|
47
|
+
- establishes versioning and package-boundary documentation
|
package/ai/architecture.md
CHANGED
|
@@ -1,40 +1,40 @@
|
|
|
1
|
-
# Architecture
|
|
2
|
-
|
|
3
|
-
Ngx BOS is operational software, not a marketing site. This source workspace contains a template
|
|
4
|
-
app plus the reusable `@wawjs/ngx-bos` package.
|
|
5
|
-
|
|
6
|
-
## Template App Architecture
|
|
7
|
-
|
|
8
|
-
The `src/` template app owns:
|
|
9
|
-
|
|
10
|
-
- browser-only Angular bootstrap
|
|
11
|
-
- guest, authenticated, and admin route areas
|
|
12
|
-
- route guards and permission decisions
|
|
13
|
-
- layouts, sidebar/topbar navigation, dashboard, profile, and settings
|
|
14
|
-
- workflow modules, entities, forms, tables, selectors, and detail screens
|
|
15
|
-
- environment values, API URL, app ID, socket/network behavior, languages, and branding
|
|
16
|
-
- app-specific components and integration glue that should not be published as package APIs
|
|
17
|
-
|
|
18
|
-
## Package Architecture
|
|
19
|
-
|
|
20
|
-
The package owns reusable contracts and behavior that can work across multiple BOS apps:
|
|
21
|
-
|
|
22
|
-
- shared interfaces
|
|
23
|
-
- reusable services
|
|
24
|
-
- utility functions
|
|
25
|
-
- shared guards/selectors/helpers when app-agnostic
|
|
26
|
-
- package-published AI guidance
|
|
27
|
-
|
|
28
|
-
Current reusable BOS infrastructure includes file upload APIs/components, file selector, WAW form
|
|
29
|
-
adapters, user/auth service, user guards/selectors, reusable file/form admin pages, reusable icons,
|
|
30
|
-
reusable pipes, and the `ngxBosProvide(...)` config bridge. Keep app-specific values in the
|
|
31
|
-
template app and pass them through that provider.
|
|
32
|
-
|
|
33
|
-
Package code must not import template/app-owned files such as routes, pages, layouts, environment
|
|
34
|
-
files, or business-specific modules. Consumer projects receive this behavior through
|
|
35
|
-
`@wawjs/ngx-bos` in `package.json`, not through `projects/ngx-bos`.
|
|
36
|
-
|
|
37
|
-
## SPA Contract
|
|
38
|
-
|
|
39
|
-
Do not introduce SSR, prerendering, static SEO generation, or landing-page-first structure unless
|
|
40
|
-
the developer explicitly asks. Browser-only behavior is the default.
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
Ngx BOS is operational software, not a marketing site. This source workspace contains a template
|
|
4
|
+
app plus the reusable `@wawjs/ngx-bos` package.
|
|
5
|
+
|
|
6
|
+
## Template App Architecture
|
|
7
|
+
|
|
8
|
+
The `src/` template app owns:
|
|
9
|
+
|
|
10
|
+
- browser-only Angular bootstrap
|
|
11
|
+
- guest, authenticated, and admin route areas
|
|
12
|
+
- route guards and permission decisions
|
|
13
|
+
- layouts, sidebar/topbar navigation, dashboard, profile, and settings
|
|
14
|
+
- workflow modules, entities, forms, tables, selectors, and detail screens
|
|
15
|
+
- environment values, API URL, app ID, socket/network behavior, languages, and branding
|
|
16
|
+
- app-specific components and integration glue that should not be published as package APIs
|
|
17
|
+
|
|
18
|
+
## Package Architecture
|
|
19
|
+
|
|
20
|
+
The package owns reusable contracts and behavior that can work across multiple BOS apps:
|
|
21
|
+
|
|
22
|
+
- shared interfaces
|
|
23
|
+
- reusable services
|
|
24
|
+
- utility functions
|
|
25
|
+
- shared guards/selectors/helpers when app-agnostic
|
|
26
|
+
- package-published AI guidance
|
|
27
|
+
|
|
28
|
+
Current reusable BOS infrastructure includes file upload APIs/components, file selector, WAW form
|
|
29
|
+
adapters, user/auth service, user guards/selectors, reusable file/form admin pages, reusable icons,
|
|
30
|
+
reusable pipes, and the `ngxBosProvide(...)` config bridge. Keep app-specific values in the
|
|
31
|
+
template app and pass them through that provider.
|
|
32
|
+
|
|
33
|
+
Package code must not import template/app-owned files such as routes, pages, layouts, environment
|
|
34
|
+
files, or business-specific modules. Consumer projects receive this behavior through
|
|
35
|
+
`@wawjs/ngx-bos` in `package.json`, not through `projects/ngx-bos`.
|
|
36
|
+
|
|
37
|
+
## SPA Contract
|
|
38
|
+
|
|
39
|
+
Do not introduce SSR, prerendering, static SEO generation, or landing-page-first structure unless
|
|
40
|
+
the developer explicitly asks. Browser-only behavior is the default.
|
package/ai/code-style.md
CHANGED
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
# Code Style
|
|
2
|
-
|
|
3
|
-
Follow Angular 22 and local BOS conventions.
|
|
4
|
-
|
|
5
|
-
## Angular
|
|
6
|
-
|
|
7
|
-
- use standalone components
|
|
8
|
-
- omit `changeDetection` unless a component intentionally needs `ChangeDetectionStrategy.Eager`; Angular 22 uses OnPush by default
|
|
9
|
-
- use signals, `computed()`, and `effect()` for local state
|
|
10
|
-
- use `input()`, `output()`, `model()`, `viewChild()`, and related function-based APIs
|
|
11
|
-
- use native control flow: `@if`, `@for`, and `@switch`
|
|
12
|
-
- use `inject()` instead of constructor injection for services
|
|
13
|
-
- avoid `any`; use explicit types or `unknown`
|
|
14
|
-
- prefer existing Waw services and local helpers before adding new infrastructure
|
|
15
|
-
|
|
16
|
-
## Templates
|
|
17
|
-
|
|
18
|
-
- keep operational screens dense, clear, and stable
|
|
19
|
-
- use `@let` when the same signal or expression is read more than once
|
|
20
|
-
- include loading, empty, error, and access-denied states where the workflow needs them
|
|
21
|
-
- avoid layout-shifting hover/focus behavior
|
|
22
|
-
|
|
23
|
-
## Styling
|
|
24
|
-
|
|
25
|
-
- prefer existing CSS variables and design tokens
|
|
26
|
-
- use component SCSS with readable BEM-style class names
|
|
27
|
-
- avoid arbitrary hex colors and random pixel values
|
|
28
|
-
- keep focus states visible and WCAG AA-compatible
|
|
29
|
-
|
|
30
|
-
## Forms
|
|
31
|
-
|
|
32
|
-
Use the signal-based forms API for new forms when feasible. Keep dynamic form schemas registered
|
|
33
|
-
through the existing form component registry.
|
|
1
|
+
# Code Style
|
|
2
|
+
|
|
3
|
+
Follow Angular 22 and local BOS conventions.
|
|
4
|
+
|
|
5
|
+
## Angular
|
|
6
|
+
|
|
7
|
+
- use standalone components
|
|
8
|
+
- omit `changeDetection` unless a component intentionally needs `ChangeDetectionStrategy.Eager`; Angular 22 uses OnPush by default
|
|
9
|
+
- use signals, `computed()`, and `effect()` for local state
|
|
10
|
+
- use `input()`, `output()`, `model()`, `viewChild()`, and related function-based APIs
|
|
11
|
+
- use native control flow: `@if`, `@for`, and `@switch`
|
|
12
|
+
- use `inject()` instead of constructor injection for services
|
|
13
|
+
- avoid `any`; use explicit types or `unknown`
|
|
14
|
+
- prefer existing Waw services and local helpers before adding new infrastructure
|
|
15
|
+
|
|
16
|
+
## Templates
|
|
17
|
+
|
|
18
|
+
- keep operational screens dense, clear, and stable
|
|
19
|
+
- use `@let` when the same signal or expression is read more than once
|
|
20
|
+
- include loading, empty, error, and access-denied states where the workflow needs them
|
|
21
|
+
- avoid layout-shifting hover/focus behavior
|
|
22
|
+
|
|
23
|
+
## Styling
|
|
24
|
+
|
|
25
|
+
- prefer existing CSS variables and design tokens
|
|
26
|
+
- use component SCSS with readable BEM-style class names
|
|
27
|
+
- avoid arbitrary hex colors and random pixel values
|
|
28
|
+
- keep focus states visible and WCAG AA-compatible
|
|
29
|
+
|
|
30
|
+
## Forms
|
|
31
|
+
|
|
32
|
+
Use the signal-based forms API for new forms when feasible. Keep dynamic form schemas registered
|
|
33
|
+
through the existing form component registry.
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
# Browser-Only BOS SPA
|
|
2
|
-
|
|
3
|
-
## Decision
|
|
4
|
-
|
|
5
|
-
Ngx BOS is a CRM and business operating system SPA. It is browser-only by default.
|
|
6
|
-
|
|
7
|
-
## Consequences
|
|
8
|
-
|
|
9
|
-
- no SSR by default
|
|
10
|
-
- no prerender route list by default
|
|
11
|
-
- no static SEO workflow by default
|
|
12
|
-
- no landing-page-first architecture by default
|
|
13
|
-
- authenticated workflows, dashboards, role access, and operational modules are the primary
|
|
14
|
-
product surface
|
|
15
|
-
|
|
16
|
-
Public pages may exist for entry or onboarding, but they do not define the architecture.
|
|
1
|
+
# Browser-Only BOS SPA
|
|
2
|
+
|
|
3
|
+
## Decision
|
|
4
|
+
|
|
5
|
+
Ngx BOS is a CRM and business operating system SPA. It is browser-only by default.
|
|
6
|
+
|
|
7
|
+
## Consequences
|
|
8
|
+
|
|
9
|
+
- no SSR by default
|
|
10
|
+
- no prerender route list by default
|
|
11
|
+
- no static SEO workflow by default
|
|
12
|
+
- no landing-page-first architecture by default
|
|
13
|
+
- authenticated workflows, dashboards, role access, and operational modules are the primary
|
|
14
|
+
product surface
|
|
15
|
+
|
|
16
|
+
Public pages may exist for entry or onboarding, but they do not define the architecture.
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
# Package Boundary
|
|
2
|
-
|
|
3
|
-
## Decision
|
|
4
|
-
|
|
5
|
-
Reusable BOS APIs belong in `@wawjs/ngx-bos`. Business-specific workflow belongs in the app.
|
|
6
|
-
|
|
7
|
-
## Package-Owned
|
|
8
|
-
|
|
9
|
-
- reusable interfaces
|
|
10
|
-
- app-agnostic services
|
|
11
|
-
- shared workflow utilities
|
|
12
|
-
- package-published AI guidance
|
|
13
|
-
|
|
14
|
-
## App-Owned
|
|
15
|
-
|
|
16
|
-
- routes and layouts
|
|
17
|
-
- roles and permissions
|
|
18
|
-
- dashboards and modules
|
|
19
|
-
- schemas, statuses, copy, and integrations
|
|
20
|
-
- environment values and deployment config
|
|
21
|
-
|
|
22
|
-
Consumers import from `@wawjs/ngx-bos`, not package internals.
|
|
1
|
+
# Package Boundary
|
|
2
|
+
|
|
3
|
+
## Decision
|
|
4
|
+
|
|
5
|
+
Reusable BOS APIs belong in `@wawjs/ngx-bos`. Business-specific workflow belongs in the app.
|
|
6
|
+
|
|
7
|
+
## Package-Owned
|
|
8
|
+
|
|
9
|
+
- reusable interfaces
|
|
10
|
+
- app-agnostic services
|
|
11
|
+
- shared workflow utilities
|
|
12
|
+
- package-published AI guidance
|
|
13
|
+
|
|
14
|
+
## App-Owned
|
|
15
|
+
|
|
16
|
+
- routes and layouts
|
|
17
|
+
- roles and permissions
|
|
18
|
+
- dashboards and modules
|
|
19
|
+
- schemas, statuses, copy, and integrations
|
|
20
|
+
- environment values and deployment config
|
|
21
|
+
|
|
22
|
+
Consumers import from `@wawjs/ngx-bos`, not package internals.
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
# Version Start
|
|
2
|
-
|
|
3
|
-
## Decision
|
|
4
|
-
|
|
5
|
-
The
|
|
6
|
-
|
|
7
|
-
## Consequences
|
|
8
|
-
|
|
9
|
-
- root app version and `projects/ngx-bos/package.json` version should stay aligned for platform
|
|
10
|
-
releases
|
|
11
|
-
- after publishing a version, bump the source package to the next planned version
|
|
12
|
-
- do not make the app depend on an unpublished `@wawjs/ngx-bos` version
|
|
1
|
+
# Version Start
|
|
2
|
+
|
|
3
|
+
## Decision
|
|
4
|
+
|
|
5
|
+
The initial Ngx BOS package line is `22.0.0`.
|
|
6
|
+
|
|
7
|
+
## Consequences
|
|
8
|
+
|
|
9
|
+
- root app version and `projects/ngx-bos/package.json` version should stay aligned for platform
|
|
10
|
+
releases
|
|
11
|
+
- after publishing a version, bump the source package to the next planned version
|
|
12
|
+
- do not make the app depend on an unpublished `@wawjs/ngx-bos` version
|
package/ai/decisions/index.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
# Decisions
|
|
2
|
-
|
|
3
|
-
Durable Ngx BOS decisions live in this folder.
|
|
4
|
-
|
|
5
|
-
- `2026-06-02-browser-only-bos-spa.md`
|
|
6
|
-
- `2026-06-02-package-boundary.md`
|
|
7
|
-
- `2026-06-02-version-start.md`
|
|
1
|
+
# Decisions
|
|
2
|
+
|
|
3
|
+
Durable Ngx BOS decisions live in this folder.
|
|
4
|
+
|
|
5
|
+
- `2026-06-02-browser-only-bos-spa.md`
|
|
6
|
+
- `2026-06-02-package-boundary.md`
|
|
7
|
+
- `2026-06-02-version-start.md`
|
package/ai/onboarding.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
# Onboarding
|
|
2
|
-
|
|
3
|
-
Ngx BOS is an Angular 22 CRM and business operating system template plus a reusable package.
|
|
4
|
-
|
|
5
|
-
Before editing, identify whether the task is:
|
|
6
|
-
|
|
7
|
-
- template/app-specific workflow work under `src/`
|
|
8
|
-
- reusable package work under `projects/ngx-bos`
|
|
9
|
-
- package guidance or release work
|
|
10
|
-
- Custom GPT/source documentation work
|
|
11
|
-
|
|
12
|
-
For template app work, inspect routes, guards, layouts, modules, environment files, and existing Waw
|
|
13
|
-
configuration before changing behavior. Future business apps will keep and adapt this `src/` shape.
|
|
14
|
-
|
|
15
|
-
For package work, preserve the public consumer contract and export reusable APIs from
|
|
16
|
-
`projects/ngx-bos/src/public-api.ts`.
|
|
17
|
-
|
|
18
|
-
Delivered business apps may not contain `projects/ngx-bos`, root `documentation/`, or
|
|
19
|
-
`custom-gpt/`. Do not write guidance that depends on those folders.
|
|
1
|
+
# Onboarding
|
|
2
|
+
|
|
3
|
+
Ngx BOS is an Angular 22 CRM and business operating system template plus a reusable package.
|
|
4
|
+
|
|
5
|
+
Before editing, identify whether the task is:
|
|
6
|
+
|
|
7
|
+
- template/app-specific workflow work under `src/`
|
|
8
|
+
- reusable package work under `projects/ngx-bos`
|
|
9
|
+
- package guidance or release work
|
|
10
|
+
- Custom GPT/source documentation work
|
|
11
|
+
|
|
12
|
+
For template app work, inspect routes, guards, layouts, modules, environment files, and existing Waw
|
|
13
|
+
configuration before changing behavior. Future business apps will keep and adapt this `src/` shape.
|
|
14
|
+
|
|
15
|
+
For package work, preserve the public consumer contract and export reusable APIs from
|
|
16
|
+
`projects/ngx-bos/src/public-api.ts`.
|
|
17
|
+
|
|
18
|
+
Delivered business apps may not contain `projects/ngx-bos`, root `documentation/`, or
|
|
19
|
+
`custom-gpt/`. Do not write guidance that depends on those folders.
|