express-file-cluster 0.3.15 → 0.7.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.
- package/README.md +71 -33
- package/dist/auth/index.cjs +12 -2
- package/dist/auth/index.cjs.map +1 -1
- package/dist/auth/index.d.cts +13 -2
- package/dist/auth/index.d.ts +13 -2
- package/dist/auth/index.js +12 -2
- package/dist/chunk-277BSYVH.js +127 -0
- package/dist/chunk-277BSYVH.js.map +1 -0
- package/dist/chunk-6OGOVV57.js +3847 -0
- package/dist/chunk-6OGOVV57.js.map +1 -0
- package/dist/chunk-7YEX4MQV.cjs +38 -0
- package/dist/chunk-7YEX4MQV.cjs.map +1 -0
- package/dist/chunk-AZYXQU3Z.cjs +3847 -0
- package/dist/chunk-AZYXQU3Z.cjs.map +1 -0
- package/dist/chunk-BUBXO7WU.js +170 -0
- package/dist/chunk-BUBXO7WU.js.map +1 -0
- package/dist/chunk-LJNSJFOL.js +38 -0
- package/dist/chunk-LJNSJFOL.js.map +1 -0
- package/dist/chunk-MGH4VDV3.cjs +170 -0
- package/dist/chunk-MGH4VDV3.cjs.map +1 -0
- package/dist/chunk-R34R7QPD.cjs +116 -0
- package/dist/chunk-R34R7QPD.cjs.map +1 -0
- package/dist/chunk-RS4MXCPW.js +116 -0
- package/dist/chunk-RS4MXCPW.js.map +1 -0
- package/dist/chunk-T4OHFU5T.cjs +154 -0
- package/dist/chunk-T4OHFU5T.cjs.map +1 -0
- package/dist/chunk-TI24L4XE.cjs.map +1 -1
- package/dist/chunk-TRC4DUZB.js +438 -0
- package/dist/chunk-TRC4DUZB.js.map +1 -0
- package/dist/chunk-TYR2GZZE.cjs +196 -0
- package/dist/chunk-TYR2GZZE.cjs.map +1 -0
- package/dist/chunk-UBQYQPBU.js +154 -0
- package/dist/chunk-UBQYQPBU.js.map +1 -0
- package/dist/chunk-UTM4PEVG.js +196 -0
- package/dist/chunk-UTM4PEVG.js.map +1 -0
- package/dist/chunk-YL37D6KM.cjs +127 -0
- package/dist/chunk-YL37D6KM.cjs.map +1 -0
- package/dist/chunk-ZDM5JHVK.cjs +438 -0
- package/dist/chunk-ZDM5JHVK.cjs.map +1 -0
- package/dist/cli/db-runner.cjs +497 -0
- package/dist/cli/db-runner.cjs.map +1 -0
- package/dist/cli/db-runner.d.cts +2 -0
- package/dist/cli/db-runner.d.ts +2 -0
- package/dist/cli/db-runner.js +497 -0
- package/dist/cli/db-runner.js.map +1 -0
- package/dist/cli/index.cjs +447 -69
- package/dist/cli/index.cjs.map +1 -1
- package/dist/cli/index.js +473 -95
- package/dist/cli/index.js.map +1 -1
- package/dist/docs/api-reference/auth.md +232 -0
- package/dist/docs/api-reference/compose.md +78 -0
- package/dist/docs/api-reference/db.md +351 -0
- package/dist/docs/api-reference/http-error.md +109 -0
- package/dist/docs/api-reference/ignite.md +326 -0
- package/dist/docs/api-reference/table.md +458 -0
- package/dist/docs/api-reference/tasks.md +140 -0
- package/dist/docs/cli/db.md +38 -0
- package/dist/docs/cli/diagnostics.md +145 -0
- package/dist/docs/cli/generate.md +120 -0
- package/dist/docs/cli/index.md +48 -0
- package/dist/docs/cli/start.md +112 -0
- package/dist/docs/contributing/index.md +139 -0
- package/dist/docs/core-concepts/background-tasks.md +228 -0
- package/dist/docs/core-concepts/clustering.md +114 -0
- package/dist/docs/core-concepts/file-based-routing.md +235 -0
- package/dist/docs/core-concepts/index.md +79 -0
- package/dist/docs/core-concepts/middleware.md +144 -0
- package/dist/docs/getting-started/index.md +91 -0
- package/dist/docs/getting-started/project-structure.md +154 -0
- package/dist/docs/guides/ai-agents.md +48 -0
- package/dist/docs/guides/authentication.md +196 -0
- package/dist/docs/guides/caching.md +124 -0
- package/dist/docs/guides/database.md +217 -0
- package/dist/docs/guides/deployment.md +171 -0
- package/dist/docs/guides/environment-variables.md +106 -0
- package/dist/docs/guides/error-handling.md +172 -0
- package/dist/docs/guides/generated-portals.md +115 -0
- package/dist/docs/guides/logging.md +108 -0
- package/dist/docs/guides/mailer.md +166 -0
- package/dist/docs/guides/migrations.md +106 -0
- package/dist/docs/guides/rbac.md +89 -0
- package/dist/docs/guides/validation.md +95 -0
- package/dist/docs/index.md +93 -0
- package/dist/docs/skills/SKILL.md +44 -0
- package/dist/docs/skills/api-surface.md +309 -0
- package/dist/docs/skills/auth-internals.md +141 -0
- package/dist/docs/skills/pre-flight.md +142 -0
- package/dist/docs/skills/routing-rules.md +114 -0
- package/dist/docs/skills/tasks-internals.md +172 -0
- package/dist/docs/skills/what-not-to-invent.md +251 -0
- package/dist/index.cjs +264 -391
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +699 -7
- package/dist/index.d.ts +699 -7
- package/dist/index.js +258 -385
- package/dist/index.js.map +1 -1
- package/dist/pgboss-backend-QKBXVJ6B.js +14 -0
- package/dist/pgboss-backend-QKBXVJ6B.js.map +1 -0
- package/dist/pgboss-backend-TCHI7CHM.cjs +14 -0
- package/dist/pgboss-backend-TCHI7CHM.cjs.map +1 -0
- package/dist/tasks/index.cjs.map +1 -1
- package/dist/tasks/index.d.cts +1 -1
- package/dist/tasks/index.d.ts +1 -1
- package/dist/types-B6lVw4bj.d.cts +588 -0
- package/dist/types-B6lVw4bj.d.ts +588 -0
- package/package.json +28 -5
- package/dist/chunk-6522HS2J.cjs +0 -99
- package/dist/chunk-6522HS2J.cjs.map +0 -1
- package/dist/chunk-DGVOJNR6.cjs +0 -55
- package/dist/chunk-DGVOJNR6.cjs.map +0 -1
- package/dist/chunk-KOHLLUN7.js +0 -55
- package/dist/chunk-KOHLLUN7.js.map +0 -1
- package/dist/chunk-VIP3PFWZ.js +0 -99
- package/dist/chunk-VIP3PFWZ.js.map +0 -1
- package/dist/types-BusbSenn.d.cts +0 -162
- package/dist/types-BusbSenn.d.ts +0 -162
package/dist/types-BusbSenn.d.ts
DELETED
|
@@ -1,162 +0,0 @@
|
|
|
1
|
-
import { RequestHandler, ErrorRequestHandler } from 'express';
|
|
2
|
-
|
|
3
|
-
type DatabaseEngine = 'mongodb' | 'postgresql';
|
|
4
|
-
type AuthStrategy = 'http-only' | 'localStorage';
|
|
5
|
-
type TaskBackend = 'bullmq' | 'pg-boss';
|
|
6
|
-
interface TaskConfig {
|
|
7
|
-
backend: TaskBackend;
|
|
8
|
-
redisUrl?: string;
|
|
9
|
-
concurrency?: number;
|
|
10
|
-
}
|
|
11
|
-
interface CorsConfig {
|
|
12
|
-
origin?: string | string[] | boolean;
|
|
13
|
-
methods?: string | string[];
|
|
14
|
-
allowedHeaders?: string | string[];
|
|
15
|
-
credentials?: boolean;
|
|
16
|
-
maxAge?: number;
|
|
17
|
-
}
|
|
18
|
-
interface EFCConfig {
|
|
19
|
-
port?: number;
|
|
20
|
-
basePath?: string;
|
|
21
|
-
dashboard?: boolean;
|
|
22
|
-
database?: DatabaseEngine;
|
|
23
|
-
databaseUrl?: string;
|
|
24
|
-
authStrategy?: AuthStrategy;
|
|
25
|
-
jwtSecret?: string;
|
|
26
|
-
/** JWT lifetime, e.g. '15m', '1h', '7d'. Default: '7d'. */
|
|
27
|
-
jwtExpiresIn?: string;
|
|
28
|
-
/** Cookie domain for the 'http-only' auth strategy. Default: unset (host-only cookie). */
|
|
29
|
-
cookieDomain?: string;
|
|
30
|
-
cluster?: boolean;
|
|
31
|
-
workers?: number;
|
|
32
|
-
tasks?: TaskConfig | false;
|
|
33
|
-
cors?: boolean | CorsConfig;
|
|
34
|
-
/** Request timeout in milliseconds. Requests exceeding this duration will be terminated with 408. */
|
|
35
|
-
requestTimeout?: number;
|
|
36
|
-
globalMiddlewares?: RequestHandler[];
|
|
37
|
-
onWorkerReady?: (id: number) => void;
|
|
38
|
-
onWorkerCrash?: (id: number, code: number) => void;
|
|
39
|
-
onError?: ErrorRequestHandler;
|
|
40
|
-
}
|
|
41
|
-
interface RouteEntry {
|
|
42
|
-
urlPath: string;
|
|
43
|
-
filePath: string;
|
|
44
|
-
params: string[];
|
|
45
|
-
}
|
|
46
|
-
interface RouteMethodMeta {
|
|
47
|
-
description?: string;
|
|
48
|
-
request?: {
|
|
49
|
-
headers?: Record<string, string>;
|
|
50
|
-
params?: Record<string, string>;
|
|
51
|
-
query?: Record<string, string>;
|
|
52
|
-
body?: unknown;
|
|
53
|
-
};
|
|
54
|
-
response?: {
|
|
55
|
-
status?: number;
|
|
56
|
-
body?: unknown;
|
|
57
|
-
};
|
|
58
|
-
}
|
|
59
|
-
/**
|
|
60
|
-
* Keyed by HTTP method (`GET`, `POST`, ...) so each method implemented in a
|
|
61
|
-
* route file gets its own documentation block in the dashboard.
|
|
62
|
-
*/
|
|
63
|
-
type RouteMeta = Partial<Record<string, RouteMethodMeta>>;
|
|
64
|
-
interface TaskOptions {
|
|
65
|
-
thread?: boolean;
|
|
66
|
-
retries?: number;
|
|
67
|
-
backoff?: 'fixed' | 'exponential';
|
|
68
|
-
concurrency?: number;
|
|
69
|
-
schedule?: string;
|
|
70
|
-
}
|
|
71
|
-
interface TaskDefinition<TPayload = unknown> {
|
|
72
|
-
handler: (payload: TPayload) => Promise<void>;
|
|
73
|
-
options: TaskOptions;
|
|
74
|
-
name: string;
|
|
75
|
-
filePath?: string;
|
|
76
|
-
}
|
|
77
|
-
/** Primitive field types usable directly, or as the item type of an `array` field via `of`. */
|
|
78
|
-
type PrimitiveFieldType = 'string' | 'number' | 'boolean' | 'date' | 'object' | 'objectId';
|
|
79
|
-
/**
|
|
80
|
-
* Sentinel default-value codes, resolved at schema-compile time to a generator
|
|
81
|
-
* function so each document gets a freshly-computed value (never baked in once
|
|
82
|
-
* at schema-definition time):
|
|
83
|
-
* - `'$now'` — the current `Date` (pair with `type: 'date'`)
|
|
84
|
-
* - `'$uuid'` — a fresh `crypto.randomUUID()` string (pair with `type: 'string'`)
|
|
85
|
-
* - `'$objectId'` — a fresh Mongoose `ObjectId` (pair with `type: 'objectId'`)
|
|
86
|
-
* - `'$timestamp'` — the current epoch milliseconds as a `number` (pair with `type: 'number'`)
|
|
87
|
-
* - `'$shortId'` — a random 16-character base64url string (pair with `type: 'string'`);
|
|
88
|
-
* a shorter, non-UUID-shaped alternative to `'$uuid'` for tokens/keys
|
|
89
|
-
* - `'$currentUser'` — the JWT payload `requireAuth` attached to the in-flight request
|
|
90
|
-
* (via `getCurrentUser()`), or `undefined` outside a request / without `requireAuth`
|
|
91
|
-
* - `` `$currentUser.<key>` `` — a single field plucked from that payload, e.g.
|
|
92
|
-
* `'$currentUser.id'` (pair with a `type` matching that field's shape)
|
|
93
|
-
*
|
|
94
|
-
* `'$increment'` is intentionally NOT a `default` code — see `FieldDefinition.sequence`
|
|
95
|
-
* instead. Auto-increment needs an async read-modify-write against a counters
|
|
96
|
-
* collection; mongoose resolves `default` synchronously, so it can't live here.
|
|
97
|
-
*
|
|
98
|
-
* Any other string/value passed to `default` is used as a literal default, unchanged.
|
|
99
|
-
*/
|
|
100
|
-
type DefaultOperator = '$now' | '$uuid' | '$objectId' | '$timestamp' | '$shortId' | '$currentUser' | `$currentUser.${string}`;
|
|
101
|
-
interface FieldDefinition {
|
|
102
|
-
type: PrimitiveFieldType | 'array';
|
|
103
|
-
required?: boolean;
|
|
104
|
-
unique?: boolean;
|
|
105
|
-
/** A literal default value, or a `DefaultOperator` sentinel code (see above). */
|
|
106
|
-
default?: unknown;
|
|
107
|
-
/** Restricts the field to a fixed set of values. Valid on `string` and `number` types. */
|
|
108
|
-
enum?: readonly (string | number)[];
|
|
109
|
-
/** Mongoose model name to reference. Valid on `objectId` types (bare or as an array's `of`). */
|
|
110
|
-
ref?: string;
|
|
111
|
-
/** Item type for `array` fields, e.g. `{ type: 'array', of: 'string' }`. Omit for an untyped array. */
|
|
112
|
-
of?: PrimitiveFieldType;
|
|
113
|
-
/**
|
|
114
|
-
* Auto-increments a shared counter (stored in an internal `efc_counters` collection)
|
|
115
|
-
* and assigns it on insert, before `required` validation runs. `true` uses
|
|
116
|
-
* `'<ModelName>.<field>'` as the counter key; a string sets an explicit key so
|
|
117
|
-
* multiple fields/models can share one counter (e.g. a global order number).
|
|
118
|
-
* Only supported on top-level fields — not inside nested array sub-schemas.
|
|
119
|
-
*/
|
|
120
|
-
sequence?: boolean | string;
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* A schema field is either a `FieldDefinition`, or a one-element tuple holding a nested
|
|
124
|
-
* `ModelSchema` — the latter defines an array of embedded sub-documents, e.g.:
|
|
125
|
-
* `route_progress: [{ route_id: { type: 'string' } }]`
|
|
126
|
-
*/
|
|
127
|
-
type ModelSchema = Record<string, FieldDefinition | [ModelSchema]>;
|
|
128
|
-
interface ModelQueryOptions {
|
|
129
|
-
/** Mongoose `.populate()` path(s) to resolve on `objectId`/ref fields. */
|
|
130
|
-
populate?: string | string[];
|
|
131
|
-
}
|
|
132
|
-
interface ModelOptions {
|
|
133
|
-
/**
|
|
134
|
-
* Passed straight through to mongoose's own schema `timestamps` option.
|
|
135
|
-
* `true` (the default) adds `createdAt`/`updatedAt`; `false` disables both;
|
|
136
|
-
* an object lets you rename or selectively disable one, e.g.
|
|
137
|
-
* `{ createdAt: 'created_at', updatedAt: false }`.
|
|
138
|
-
*/
|
|
139
|
-
timestamps?: boolean | {
|
|
140
|
-
createdAt?: string | false;
|
|
141
|
-
updatedAt?: string | false;
|
|
142
|
-
};
|
|
143
|
-
}
|
|
144
|
-
interface ModelCRUD<T extends object> {
|
|
145
|
-
find(filter?: Partial<T>, options?: ModelQueryOptions): Promise<T[]>;
|
|
146
|
-
findById(id: string, options?: ModelQueryOptions): Promise<(T & {
|
|
147
|
-
id: string;
|
|
148
|
-
}) | null>;
|
|
149
|
-
findOne(filter: Partial<T>, options?: ModelQueryOptions): Promise<(T & {
|
|
150
|
-
id: string;
|
|
151
|
-
}) | null>;
|
|
152
|
-
create(data: Partial<T>): Promise<T & {
|
|
153
|
-
id: string;
|
|
154
|
-
}>;
|
|
155
|
-
update(id: string, data: Partial<T>): Promise<(T & {
|
|
156
|
-
id: string;
|
|
157
|
-
}) | null>;
|
|
158
|
-
delete(id: string): Promise<void>;
|
|
159
|
-
count(filter?: Partial<T>): Promise<number>;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
export type { AuthStrategy as A, CorsConfig as C, DatabaseEngine as D, EFCConfig as E, FieldDefinition as F, ModelSchema as M, RouteEntry as R, TaskOptions as T, TaskDefinition as a, ModelOptions as b, ModelCRUD as c, DefaultOperator as d, ModelQueryOptions as e, RouteMeta as f, RouteMethodMeta as g };
|