@rxap/schematic-angular 19.1.1-dev.2 → 19.2.0-dev.0

package/src/examples/feature/report/report-table/schematic.yaml

@@ -0,0 +1,66 @@
+package: "@rxap/schematic-angular"
+name: table-component
+options:
+  name: report
+  backend: nestjs
+  sortable: true
+  rowId:
+    name: uuid
+  modifiers:
+    - show-archived-slide
+  headerButton:
+    role: form
+    permission: report.create
+    options:
+      customComponent: true
+      formComponent: CreateForm
+  propertyList:
+    - name: __archived
+      type: boolean
+  columnList:
+    - name: __removedAt
+      kind: date
+      inactive: true
+      hidden: true
+    - name: resultType
+      kind: icon
+    - name: name
+      type: string
+      hasFilter: true
+    - name: companyName
+      type: string
+      hasFilter: true
+    - name: locationName
+      type: string
+      hasFilter: true
+  actionList:
+    - type: details
+      icon: visibility
+      permission: report.get
+      role: navigation
+      checkFunction: "!element.__archived"
+      options:
+        route: "/report/{{rowId}}/details"
+    - type: delete
+      icon: delete
+      refresh: true
+      confirm: true
+      inHeader: true
+      permission: report.delete
+      checkFunction: "!!element.__archived"
+      role: operation
+      color: warn
+    - type: archive
+      role: operation
+      refresh: true
+      confirm: true
+      inHeader: true
+      permission: report.archive
+      checkFunction: "!element.__archived"
+    - type: restore
+      role: operation
+      refresh: true
+      inHeader: true
+      confirm: true
+      permission: report.archive
+      checkFunction: "!!element.__archived"

package/src/examples/feature/service-network/company-accordion/schematic.yaml

@@ -0,0 +1,119 @@
+package: "@rxap/schematic-angular"
+name: accordion-component
+options:
+  name: company
+  backend: nestjs
+  multiple: true
+  header:
+    property:
+      name: name
+  identifier:
+    source: route
+    property:
+      name: uuid
+  upstream:
+    kind: open-api
+    operationId: company-gui-controller-getByUuid@legacy
+  itemList:
+    - name: servicenetworks
+      kind: table
+      title: Service Networks
+      table:
+        sortable: true
+        rowId:
+          name: uuid
+        upstream:
+          kind: open-api
+          operationId: get_api_companies_inherited_routers@service-server
+          mapper:
+            kind: paged
+            total: meta?.pages
+            list: routers
+            pageIndex: page
+            pageSize: per_page
+            sortBy: sort
+            sortDirection: order
+            filter:
+              property: filters
+              map:
+                filter: value
+        sort:
+          direction: asc
+          active: name
+        columnList:
+          - name: name
+            kind: default
+            filterControl:
+              kind: input
+          - name: vpn-server-ip
+            kind: copy-to-clipboard
+            isOptional: true
+            source: subnet?.server_ip
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[160px]'
+          - name: netmask-server
+            kind: copy-to-clipboard
+            source: subnet?.netmask
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[180px]'
+          - name: vpn-router-ip
+            isOptional: true
+            source: ip
+            kind: copy-to-clipboard
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[160px]'
+          - name: vpn-port
+            kind: default
+            source: subnet?.port
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[140px]'
+          - name: vpn-proto
+            kind: default
+            source: subnet?.protocol
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[160px]'
+          - name: vpn-dhcp-start
+            kind: copy-to-clipboard
+            source: subnet?.dhcp_start
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[170px]'
+          - name: vpn-dhcp-end
+            kind: copy-to-clipboard
+            source: subnet?.dhcp_end
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[160px]'
+          - name: ip-servicenet
+            kind: copy-to-clipboard
+            source: subnet?.plantnet_ip
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[160px]'
+          - name: netmask-servicenet
+            kind: copy-to-clipboard
+            isOptional: true
+            source: subnet?.plantnet_mask
+            filterControl:
+              kind: input
+              formField:
+                cssClass: 'w-[210px]'
+          - name: comment
+            kind: default
+            isOptional: true
+            source: subnet?.comment
+            filterControl:
+              kind: input

package/src/examples/feature/service-network/service-network-accordion/schematic.yml

@@ -0,0 +1,65 @@
+package: "@rxap/schematic-angular"
+name: accordion-component
+options:
+  name: service-network
+  backend: nestjs
+  multiple: true
+  header:
+    property:
+      name: name
+  persistent:
+    property:
+      name: uuid
+  identifier:
+    source: route
+    property:
+      name: uuid
+  upstream:
+    kind: open-api
+    operationId: vpn-router-controller-getByUuid@legacy
+  itemList:
+    - name: log-viewer
+      upstream:
+        kind: open-api
+        operationId: get_api_logs_retrieve_log@service-server
+    - name: connection-log
+      kind: table
+      table:
+        sortable:
+          enabled: true
+          default:
+            active: router
+            direction: asc
+        upstream:
+          kind: open-api
+          operationId: get_api_logs_connection_logs_get_connectionlogs_for_subnet@service-server
+          mapper:
+            kind: paged
+            pageIndex: page
+            pageSize: per_page
+            sortBy: sort
+            sortDirection: order
+            total: meta.total
+            list: connection_logs
+        columnList:
+          - name: router
+            filterControl:
+              kind: input
+          - name: username
+            filterControl:
+              kind: input
+          - name: clientIp
+            filterControl:
+              kind: input
+          - name: reason
+            filterControl:
+              kind: input
+          - name: begin
+            type: string
+            kind: date
+          - name: end
+            type: string
+            kind: date
+          - name: duration
+          - name: bytesSent
+          - name: bytesReceived

package/src/examples/feature/thing/thing-table/schematic.yml

@@ -0,0 +1,115 @@
+package: "@rxap/schematic-angular"
+name: table-component
+options:
+  name: thing
+  backend: open-api
+  title: Router
+  sortable: true
+  modifiers:
+    - show-archived-slide
+  headerButton:
+    role: form
+    permission: thing.create
+    options:
+      customComponent: true
+      formComponent: ThingCreateForm
+  openApi:
+    operationId: thing-gui-controller-getByFilter
+    adapter:
+      name: TableAdapterFactory
+      moduleSpecifier: "@digitaix/eurogard-table-system"
+  columnList:
+    - name: __removedAt
+      kind: date
+      inactive: true
+      hidden: true
+    - name: name
+      hasFilter: true
+    - name: macAddress
+      hasFilter: true
+    - name: uuid
+      kind: copy-to-clipboard
+      hasFilter: true
+      inactive: true
+    - name: accessKey
+      kind: copy-to-clipboard
+      hasFilter: true
+      inactive: true
+    - name: locationName
+      hasFilter: true
+    - name: lastConnection
+      kind: date
+    - name: online
+      kind: boolean
+    - name: companyName
+      hasFilter: true
+    - name: type
+      pipeList:
+        - name: thingTyp
+          namedImport: ThingTypPipe
+          moduleSpecifier: "@digitaix/eurogard-pipes"
+  actionList:
+    - type: edit
+      role: form
+      permission: thing.update
+      checkFunction: "!element.__archived"
+      refresh: true
+      options:
+        customComponent: true
+        formComponent: ThingEditForm
+        loadFrom:
+          operationId: thing-gui-controller-getByUuid
+          parameters:
+            uuid: rowId
+        formInitial:
+          name: name
+          macAddress: macAddress
+          token: token
+          onlineInterval: onlineInterval
+          location:
+            uuid: locationUuid
+            name: locationName
+          type: type
+          nodeRedExist: nodeRedExist
+    - type: vpn
+      icon: vpn_lock
+      checkFunction: "element['subnet'] !== null && !element.__archived"
+      role: navigation
+      options:
+        route: "/vpn/{{uuid}}/details"
+    - type: delete
+      icon: delete
+      refresh: true
+      confirm: true
+      inHeader: true
+      permission: thing.archive
+      checkFunction: "!!element.__archived"
+      role: open-api
+      color: warn
+      options:
+        operationId: thing-controller-delete
+        parameters:
+          uuid: rowId
+    - type: archive
+      role: open-api
+      refresh: true
+      confirm: true
+      inHeader: true
+      permission: thing.archive
+      checkFunction: "!element.__archived"
+      options:
+        operationId: thing-controller-archive
+        parameters:
+          uuid: rowId
+    - type: restore
+      role: open-api
+      refresh: true
+      inHeader: true
+      confirm: true
+      permission: thing.archive
+      checkFunction: "!!element.__archived"
+      options:
+        operationId: thing-controller-unarchive
+        parameters:
+          uuid: rowId
+

package/src/examples/feature/user/user-table/schematic.yaml

@@ -0,0 +1,99 @@
+package: "@rxap/schematic-angular"
+name: table-component
+options:
+  name: user
+  backend: open-api
+  sortable: true
+  modifiers:
+    - show-archived-slide
+  headerButton:
+    role: form
+    permission: user.create
+    options:
+      customComponent: true
+      formComponent: UserCreateForm
+  openApi:
+    operationId: user-controller-getByFilter
+    adapter:
+      name: TableAdapterFactory
+      moduleSpecifier: "@digitaix/eurogard-table-system"
+  columnList:
+    - name: __removedAt
+      kind: date
+      inactive: true
+      hidden: true
+    - name: username
+      hasFilter: true
+      type: string
+    - name: firstname
+      hasFilter: true
+      type: string
+    - name: lastname
+      hasFilter: true
+      type: string
+    - name: role
+      pipeList:
+        - name: toRolesEnumValue
+          namedImport: ToRolesEnumValuePipe
+          moduleSpecifier: enum
+        - async
+    - name: lastConnection
+      kind: date
+    - name: receiveMessages
+      kind: boolean
+    - name: companyName
+      type: string
+      hasFilter: true
+  actionList:
+    - type: edit
+      role: form
+      permission: user.update
+      checkFunction: "!element.__archived"
+      refresh: true
+      options:
+        customComponent: true
+        formComponent: UserEditForm
+        loadFrom:
+          operationId: user-controller-getByUuid
+          parameters:
+            uuid: rowId
+    - type: delete
+      icon: delete
+      refresh: true
+      confirm: true
+      inHeader: true
+      permission: user.archive
+      checkFunction: "!!element.__archived"
+      role: open-api
+      color: warn
+      options:
+        operationId: user-controller-delete
+        parameters:
+          uuid: rowId
+    - type: archive
+      role: open-api
+      refresh: true
+      confirm: true
+      inHeader: true
+      permission: user.archive
+      checkFunction: "!element.__archived"
+      options:
+        operationId: user-controller-archive
+        parameters:
+          uuid: rowId
+    - type: restore
+      role: open-api
+      refresh: true
+      inHeader: true
+      confirm: true
+      permission: user.archive
+      checkFunction: "!!element.__archived"
+      options:
+        operationId: user-controller-unarchive
+        parameters:
+          uuid: rowId
+    - type: set-password
+      permission: user.set-password
+      checkFunction: "!element.__archived"
+      svgIcon: lock-reset
+

package/src/examples/schematics.yaml

@@ -0,0 +1,18 @@
+- package: '@rxap/plugin-workspace'
+  name: init
+  options:
+    packages: false
+    standalone: false
+    skipLicense: true
+- package: '@rxap/plugin-gitlab-ci'
+  name: init
+  options:
+    onlyPackages: false
+    dte: true
+    skipFormat: false
+- package: '@rxap/plugin-gitlab-ci'
+  name: docker
+  options:
+    tags:
+      - kaniko
+    skipFormat: false

package/src/guides/backend.md

@@ -0,0 +1,49 @@
+# Backend Configuration Guide
+
+The `backend` property defines how the table component retrieves data and whether a backend controller should be generated.
+
+## Backend Kinds
+
+| Kind | Description |
+| :--- | :--- |
+| `none` | No backend integration. Uses mock data (default). |
+| `nestjs` | Generates a NestJS controller and connects the table to it. |
+| `open-api` | Connects the table to an existing OpenAPI-generated client. |
+| `local` | Uses local data (static or from a local service). |
+| `data-source` | Uses a custom data source implementation. |
+
+## NestJS Backend
+
+When using `kind: nestjs`, the schematic will generate a controller in the specified `nestModule`.
+
+```yaml
+backend:
+  kind: nestjs
+  project: api-app # Optional: Backend project name
+nestModule: api-user
+```
+
+### Generated Controller
+The generated controller will include a `getPage` method that handles:
+- Pagination
+- Sorting
+- Filtering
+
+## OpenAPI Backend
+
+When using `kind: open-api`, you must specify the `operationId` of the API endpoint.
+
+```yaml
+backend:
+  kind: open-api
+  serverId: main # Optional: Server ID from OpenAPI spec
+openApi:
+  operationId: listUsers
+```
+
+## Global Backend Options
+
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `project` | `string` | The target project for the backend code. |
+| `serverId` | `string` | The OpenAPI server ID to use. |

package/src/guides/form-component.md

@@ -0,0 +1,58 @@
+# Form Component Guide
+
+The `form-component` schematic generates a reactive Angular form component, which can be used as a standalone page, a dialog, or integrated into other components like tables.
+
+## Basic Usage
+
+To generate a form component, define it in your schematic configuration:
+
+```yaml
+- package: "@rxap/schematic-angular"
+  name: form-component
+  options:
+    name: user-edit
+    project: admin-panel
+    feature: user
+    controlList:
+      - name: email
+        kind: input
+        label: Email Address
+        required: true
+      - name: role
+        kind: select
+        label: Role
+        options:
+          - value: admin
+            label: Admin
+          - value: user
+            label: User
+```
+
+## Properties
+
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `name` | `string` | The name of the form component. |
+| `project` | `string` | The target project. |
+| `feature` | `string` | The feature module. |
+| `controlList` | `array` | [Control Definitions](./form-control.md) |
+| `window` | `boolean` | If `true`, the form is designed to open in a window/dialog. |
+| `role` | `string` | The role of the form (e.g., `form`, `search`). |
+| `matFormFieldDefaultOptions` | `object` | Default options for Material form fields (e.g., `appearance`). |
+
+## Usage in Tables
+
+Forms are often used as actions within a [Table Component](./table-component.md). You can define a form inline using the `formOptions` property in a table action.
+
+```yaml
+actionList:
+  - type: create
+    kind: form
+    icon: add
+    formOptions:
+      controlList:
+        - name: title
+          required: true
+```
+
+For more details on integrating forms with tables, see the [Table Action Guide](./table-action.md#form-actions).