@venizia/ignis-docs 0.0.4 → 0.0.5
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/package.json +2 -2
- package/wiki/best-practices/code-style-standards/function-patterns.md +31 -5
- package/wiki/best-practices/performance-optimization.md +39 -0
- package/wiki/best-practices/troubleshooting-tips.md +24 -3
- package/wiki/guides/tutorials/realtime-chat.md +724 -460
- package/wiki/references/base/filter-system/json-filtering.md +4 -2
- package/wiki/references/base/middlewares.md +24 -72
- package/wiki/references/base/repositories/advanced.md +83 -0
- package/wiki/references/base/repositories/index.md +1 -1
- package/wiki/references/components/socket-io.md +495 -78
- package/wiki/references/helpers/logger.md +222 -43
- package/wiki/references/helpers/network.md +273 -31
- package/wiki/references/helpers/socket-io.md +881 -71
- package/wiki/references/quick-reference.md +3 -5
- package/wiki/references/src-details/core.md +1 -2
- package/wiki/references/utilities/statuses.md +4 -2
|
@@ -499,8 +499,10 @@ if (Statuses.isCompleted(order.status)) {
|
|
|
499
499
|
| `RUNNING` | `'202_RUNNING'` | Active |
|
|
500
500
|
| `COMPLETED` | `'303_COMPLETED'` | Completed |
|
|
501
501
|
| `SUCCESS` | `'302_SUCCESS'` | Completed |
|
|
502
|
+
| `CONFIRMED` | `'305_CONFIRMED'` | Completed |
|
|
502
503
|
| `SUSPENDED` | `'402_SUSPENDED'` | Inactive |
|
|
503
504
|
| `ARCHIVED` | `'405_ARCHIVED'` | Inactive |
|
|
505
|
+
| `REFUNDED` | `'408_REFUNDED'` | Inactive |
|
|
504
506
|
| `FAIL` | `'500_FAIL'` | Failed |
|
|
505
507
|
| `CANCELLED` | `'505_CANCELLED'` | Failed |
|
|
506
508
|
| `DELETED` | `'506_DELETED'` | Failed |
|
|
@@ -515,17 +517,13 @@ if (Statuses.isCompleted(order.status)) {
|
|
|
515
517
|
import {
|
|
516
518
|
appErrorHandler,
|
|
517
519
|
notFoundHandler,
|
|
518
|
-
requestNormalize,
|
|
519
520
|
RequestSpyMiddleware,
|
|
520
521
|
emojiFavicon,
|
|
521
522
|
} from '@venizia/ignis';
|
|
522
523
|
|
|
523
524
|
const app = new MyApp();
|
|
524
525
|
|
|
525
|
-
// Request
|
|
526
|
-
app.use(requestNormalize());
|
|
527
|
-
|
|
528
|
-
// Request logging
|
|
526
|
+
// Request logging and body parsing
|
|
529
527
|
const requestSpy = new RequestSpyMiddleware();
|
|
530
528
|
app.use(requestSpy.value());
|
|
531
529
|
|
|
@@ -104,8 +104,7 @@ A collection of essential, low-level middlewares used by the application.
|
|
|
104
104
|
| `app-error.middleware.ts` | Global error handling middleware that catches `ApplicationError` instances and formats responses consistently. |
|
|
105
105
|
| `emoji-favicon.middleware.ts` | Serves a simple emoji favicon for the application. |
|
|
106
106
|
| `not-found.middleware.ts` | Handles 404 Not Found errors. |
|
|
107
|
-
| `request-
|
|
108
|
-
| `request-spy.middleware.ts` | Logs incoming requests and adds a unique request ID for tracing. |
|
|
107
|
+
| `request-spy.middleware.ts` | Logs incoming requests, parses request body, and adds a unique request ID for tracing. |
|
|
109
108
|
|
|
110
109
|
#### `base/mixins`
|
|
111
110
|
|
|
@@ -143,6 +143,7 @@ Positive terminal states indicating successful completion.
|
|
|
143
143
|
| `SUCCESS` | `'302_SUCCESS'` | Successfully completed |
|
|
144
144
|
| `COMPLETED` | `'303_COMPLETED'` | Fully completed |
|
|
145
145
|
| `SETTLED` | `'304_SETTLED'` | Finalized or settled |
|
|
146
|
+
| `CONFIRMED` | `'305_CONFIRMED'` | Confirmed by user or system |
|
|
146
147
|
|
|
147
148
|
**Example Usage:**
|
|
148
149
|
```typescript
|
|
@@ -181,6 +182,7 @@ Negative but reversible states - the entity can be reactivated.
|
|
|
181
182
|
| `ARCHIVED` | `'405_ARCHIVED'` | Archived for record keeping |
|
|
182
183
|
| `PAUSED` | `'406_PAUSED'` | Paused, can be resumed |
|
|
183
184
|
| `REVOKED` | `'407_REVOKED'` | Permission or access revoked |
|
|
185
|
+
| `REFUNDED` | `'408_REFUNDED'` | Payment or transaction refunded |
|
|
184
186
|
|
|
185
187
|
**Example Usage:**
|
|
186
188
|
```typescript
|
|
@@ -252,8 +254,8 @@ The `Statuses` class provides static sets for grouping related statuses.
|
|
|
252
254
|
| Initial | `INITIAL_SCHEME_SET` | `UNKNOWN`, `DRAFT` |
|
|
253
255
|
| Pending | `PENDING_SCHEME_SET` | `NEW`, `QUEUED`, `SCHEDULED`, `PENDING`, `IN_REVIEW` |
|
|
254
256
|
| Active | `ACTIVE_SCHEME_SET` | `ENABLED`, `ACTIVATED`, `RUNNING`, `PROCESSING`, `SENT`, `RECEIVED` |
|
|
255
|
-
| Completed | `COMPLETED_SCHEME_SET` | `PARTIAL`, `APPROVED`, `SUCCESS`, `COMPLETED`, `SETTLED` |
|
|
256
|
-
| Inactive | `INACTIVE_SCHEME_SET` | `DISABLED`, `DEACTIVATED`, `SUSPENDED`, `BLOCKED`, `CLOSED`, `ARCHIVED`, `PAUSED`, `REVOKED` |
|
|
257
|
+
| Completed | `COMPLETED_SCHEME_SET` | `PARTIAL`, `APPROVED`, `SUCCESS`, `COMPLETED`, `SETTLED`, `CONFIRMED` |
|
|
258
|
+
| Inactive | `INACTIVE_SCHEME_SET` | `DISABLED`, `DEACTIVATED`, `SUSPENDED`, `BLOCKED`, `CLOSED`, `ARCHIVED`, `PAUSED`, `REVOKED`, `REFUNDED` |
|
|
257
259
|
| Failed | `FAILED_SCHEME_SET` | `FAIL`, `EXPIRED`, `TIMEOUT`, `SKIPPED`, `ABORTED`, `CANCELLED`, `DELETED`, `REJECTED` |
|
|
258
260
|
| All | `SCHEME_SET` | All statuses combined |
|
|
259
261
|
|