alepha 0.7.5 → 0.7.6

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 (98) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +44 -44
  3. package/cache/redis.cjs +4 -8
  4. package/cache/redis.d.ts +28 -89
  5. package/cache/redis.js +1 -1
  6. package/cache.cjs +4 -8
  7. package/cache.d.ts +189 -265
  8. package/cache.js +1 -1
  9. package/core.cjs +4 -8
  10. package/core.d.ts +950 -929
  11. package/core.js +1 -1
  12. package/datetime.cjs +4 -8
  13. package/datetime.d.ts +151 -146
  14. package/datetime.js +1 -1
  15. package/lock/redis.cjs +7 -49
  16. package/lock/redis.d.ts +15 -12
  17. package/lock/redis.js +1 -47
  18. package/lock.cjs +4 -8
  19. package/lock.d.ts +117 -170
  20. package/lock.js +1 -1
  21. package/package.json +70 -39
  22. package/postgres.cjs +4 -8
  23. package/postgres.d.ts +1314 -4398
  24. package/postgres.js +1 -1
  25. package/queue/redis.cjs +8 -0
  26. package/queue/redis.d.ts +31 -0
  27. package/queue/redis.js +1 -0
  28. package/queue.cjs +4 -8
  29. package/queue.d.ts +162 -205
  30. package/queue.js +1 -1
  31. package/react/auth.cjs +4 -8
  32. package/react/auth.d.ts +166 -282
  33. package/react/auth.js +1 -1
  34. package/react.cjs +4 -8
  35. package/react.d.ts +509 -551
  36. package/react.js +1 -1
  37. package/redis.cjs +4 -8
  38. package/redis.d.ts +59 -132
  39. package/redis.js +1 -1
  40. package/retry.cjs +4 -8
  41. package/retry.d.ts +34 -31
  42. package/retry.js +1 -1
  43. package/scheduler.cjs +4 -8
  44. package/scheduler.d.ts +125 -182
  45. package/scheduler.js +1 -1
  46. package/security.cjs +4 -8
  47. package/security.d.ts +472 -595
  48. package/security.js +1 -1
  49. package/server/cache.cjs +4 -8
  50. package/server/cache.d.ts +41 -38
  51. package/server/cache.js +1 -1
  52. package/server/cookies.cjs +4 -8
  53. package/server/cookies.d.ts +46 -41
  54. package/server/cookies.js +1 -1
  55. package/server/static.cjs +4 -8
  56. package/server/static.d.ts +98 -95
  57. package/server/static.js +1 -1
  58. package/server/swagger.cjs +4 -8
  59. package/server/swagger.d.ts +96 -92
  60. package/server/swagger.js +1 -1
  61. package/server.cjs +4 -8
  62. package/server.d.ts +754 -1025
  63. package/server.js +1 -1
  64. package/testing.cjs +8 -0
  65. package/testing.d.ts +1 -0
  66. package/testing.js +1 -0
  67. package/topic/redis.cjs +8 -0
  68. package/topic/redis.d.ts +45 -0
  69. package/topic/redis.js +1 -0
  70. package/topic.cjs +4 -8
  71. package/topic.d.ts +171 -163
  72. package/topic.js +1 -1
  73. package/vite.cjs +4 -8
  74. package/vite.d.ts +89 -82
  75. package/vite.js +1 -1
  76. package/src/cache/redis.ts +0 -1
  77. package/src/cache.ts +0 -1
  78. package/src/core.ts +0 -1
  79. package/src/datetime.ts +0 -1
  80. package/src/lock/redis.ts +0 -1
  81. package/src/lock.ts +0 -1
  82. package/src/postgres.ts +0 -1
  83. package/src/queue/redis.ts +0 -1
  84. package/src/queue.ts +0 -1
  85. package/src/react/auth.ts +0 -1
  86. package/src/react.ts +0 -1
  87. package/src/redis.ts +0 -1
  88. package/src/retry.ts +0 -1
  89. package/src/scheduler.ts +0 -1
  90. package/src/security.ts +0 -1
  91. package/src/server/cache.ts +0 -1
  92. package/src/server/cookies.ts +0 -1
  93. package/src/server/static.ts +0 -1
  94. package/src/server/swagger.ts +0 -1
  95. package/src/server.ts +0 -1
  96. package/src/topic/redis.ts +0 -1
  97. package/src/topic.ts +0 -1
  98. package/src/vite.ts +0 -1
package/scheduler.d.ts CHANGED
@@ -1,206 +1,148 @@
1
- import * as _alepha_core from '@alepha/core';
2
- import { Async, KIND, OPTIONS, Alepha, Static } from '@alepha/core';
3
- import { DateTime, DurationLike, DateTimeProvider, Interval } from '@alepha/datetime';
4
- import * as _alepha_lock from '@alepha/lock';
5
- import { Cron } from 'cron-schedule';
1
+ import * as _alepha_core9 from "@alepha/core";
2
+ import * as _alepha_core2 from "@alepha/core";
3
+ import { Alepha, Async, KIND, OPTIONS, Static } from "@alepha/core";
4
+ import * as _alepha_lock8 from "@alepha/lock";
5
+ import { DateTime, DateTimeProvider, DurationLike, Interval } from "@alepha/datetime";
6
+ import { Cron } from "cron-schedule";
7
+ import * as _sinclair_typebox0 from "@sinclair/typebox";
8
+ import * as dayjs10 from "dayjs";
6
9
 
10
+ //#region src/descriptors/$scheduler.d.ts
7
11
  declare const KEY = "SCHEDULER";
8
12
  /**
9
13
  * Scheduler descriptor.
10
14
  */
11
15
  declare const $scheduler: {
12
- (options: SchedulerDescriptorOptions): SchedulerDescriptor;
13
- [KIND]: string;
16
+ (options: SchedulerDescriptorOptions): SchedulerDescriptor;
17
+ [KIND]: string;
14
18
  };
15
19
  declare const isScheduler: (value: any) => value is SchedulerDescriptor;
16
20
  type SchedulerDescriptorOptions = {
17
- /**
18
- * Function to run on schedule.
19
- */
20
- handler: (args: SchedulerHandlerArguments) => Async<void>;
21
- /**
22
- * Name of the scheduler. Defaults to the function name.
23
- */
24
- name?: string;
25
- /**
26
- * Optional description of the scheduler.
27
- */
28
- description?: string;
29
- /**
30
- * Cron expression or interval to run the scheduler.
31
- */
32
- cron?: string;
33
- /**
34
- * Cron expression or interval to run the scheduler.
35
- */
36
- interval?: DurationLike;
37
- /**
38
- * If true, the scheduler will be locked and only one instance will run at a time.
39
- * You probably need to import {@link AlephaLockRedis} for distributed locking.
40
- *
41
- * @default true
42
- */
43
- lock?: boolean;
21
+ /**
22
+ * Function to run on schedule.
23
+ */
24
+ handler: (args: SchedulerHandlerArguments) => Async<void>;
25
+ /**
26
+ * Name of the scheduler. Defaults to the function name.
27
+ */
28
+ name?: string;
29
+ /**
30
+ * Optional description of the scheduler.
31
+ */
32
+ description?: string;
33
+ /**
34
+ * Cron expression or interval to run the scheduler.
35
+ */
36
+ cron?: string;
37
+ /**
38
+ * Cron expression or interval to run the scheduler.
39
+ */
40
+ interval?: DurationLike;
41
+ /**
42
+ * If true, the scheduler will be locked and only one instance will run at a time.
43
+ * You probably need to import {@link AlephaLockRedis} for distributed locking.
44
+ *
45
+ * @default true
46
+ */
47
+ lock?: boolean;
44
48
  };
45
49
  interface SchedulerDescriptor {
46
- [KIND]: typeof KEY;
47
- [OPTIONS]: SchedulerDescriptorOptions;
48
- (): Promise<void>;
50
+ [KIND]: typeof KEY;
51
+ [OPTIONS]: SchedulerDescriptorOptions;
52
+ (): Promise<void>;
49
53
  }
50
54
  interface SchedulerHandlerArguments {
51
- now: DateTime;
52
- }
53
-
54
- /** Symbol key applied to readonly types */
55
- declare const ReadonlyKind: unique symbol;
56
- /** Symbol key applied to optional types */
57
- declare const OptionalKind: unique symbol;
58
- /** Symbol key applied to types */
59
- declare const Hint: unique symbol;
60
- /** Symbol key applied to types */
61
- declare const Kind: unique symbol;
62
-
63
- type StringFormatOption = 'date-time' | 'time' | 'date' | 'email' | 'idn-email' | 'hostname' | 'idn-hostname' | 'ipv4' | 'ipv6' | 'uri' | 'uri-reference' | 'iri' | 'uuid' | 'iri-reference' | 'uri-template' | 'json-pointer' | 'relative-json-pointer' | 'regex' | ({} & string);
64
- type StringContentEncodingOption = '7bit' | '8bit' | 'binary' | 'quoted-printable' | 'base64' | ({} & string);
65
- interface StringOptions extends SchemaOptions {
66
- /** The maximum string length */
67
- maxLength?: number;
68
- /** The minimum string length */
69
- minLength?: number;
70
- /** A regular expression pattern this string should match */
71
- pattern?: string;
72
- /** A format this string should match */
73
- format?: StringFormatOption;
74
- /** The content encoding for this string */
75
- contentEncoding?: StringContentEncodingOption;
76
- /** The content media type for this string */
77
- contentMediaType?: string;
78
- }
79
- interface TString extends TSchema, StringOptions {
80
- [Kind]: 'String';
81
- static: string;
82
- type: 'string';
83
- }
84
-
85
- type TOptional<T extends TSchema> = T & {
86
- [OptionalKind]: 'Optional';
87
- };
88
-
89
- interface SchemaOptions {
90
- $schema?: string;
91
- /** Id for this schema */
92
- $id?: string;
93
- /** Title of this schema */
94
- title?: string;
95
- /** Description of this schema */
96
- description?: string;
97
- /** Default value for this schema */
98
- default?: any;
99
- /** Example values matching this schema */
100
- examples?: any;
101
- /** Optional annotation for readOnly */
102
- readOnly?: boolean;
103
- /** Optional annotation for writeOnly */
104
- writeOnly?: boolean;
105
- [prop: string]: any;
106
- }
107
- interface TKind {
108
- [Kind]: string;
55
+ now: DateTime;
109
56
  }
110
- interface TSchema extends TKind, SchemaOptions {
111
- [ReadonlyKind]?: string;
112
- [OptionalKind]?: string;
113
- [Hint]?: string;
114
- params: unknown[];
115
- static: unknown;
116
- }
117
-
57
+ //#endregion
58
+ //#region src/providers/CronScheduler.d.ts
118
59
  interface CronJob {
119
- handler: (context: {
120
- now: DateTime;
121
- }) => Promise<void>;
122
- cron: Cron;
123
- loop: boolean;
124
- running?: boolean;
125
- onError?: (error: Error) => void;
126
- abort: AbortController;
60
+ handler: (context: {
61
+ now: DateTime;
62
+ }) => Promise<void>;
63
+ cron: Cron;
64
+ loop: boolean;
65
+ running?: boolean;
66
+ onError?: (error: Error) => void;
67
+ abort: AbortController;
127
68
  }
128
69
  declare class CronProvider {
129
- protected readonly dt: DateTimeProvider;
130
- protected readonly alepha: Alepha;
131
- protected readonly log: _alepha_core.Logger;
132
- start(cron: CronJob): void;
133
- stop(cron: CronJob): void;
134
- create(expression: string, handler: (context: {
135
- now: DateTime;
136
- }) => Promise<void>): CronJob;
137
- run(task: CronJob, now?: undefined): void;
70
+ protected readonly dt: DateTimeProvider;
71
+ protected readonly alepha: Alepha;
72
+ protected readonly log: _alepha_core9.Logger;
73
+ start(cron: CronJob): void;
74
+ stop(cron: CronJob): void;
75
+ create(expression: string, handler: (context: {
76
+ now: DateTime;
77
+ }) => Promise<void>): CronJob;
78
+ run(task: CronJob, now?: dayjs10.Dayjs): void;
138
79
  }
139
-
140
- declare const envSchema: _alepha_core.TObject<{
141
- SCHEDULER_PREFIX: TOptional<TString>;
80
+ //#endregion
81
+ //#region src/providers/SchedulerDescriptorProvider.d.ts
82
+ declare const envSchema: _alepha_core2.TObject<{
83
+ SCHEDULER_PREFIX: _sinclair_typebox0.TOptional<_sinclair_typebox0.TString>;
142
84
  }>;
143
85
  declare module "alepha" {
144
- interface Env extends Partial<Static<typeof envSchema>> {
145
- }
86
+ interface Env extends Partial<Static<typeof envSchema>> {}
146
87
  }
147
88
  declare class SchedulerDescriptorProvider {
148
- protected readonly log: _alepha_core.Logger;
149
- protected readonly env: {
150
- SCHEDULER_PREFIX?: string | undefined;
151
- };
152
- protected readonly alepha: Alepha;
153
- protected readonly dateTimeProvider: DateTimeProvider;
154
- protected readonly cronProvider: CronProvider;
155
- protected readonly schedulers: Scheduler[];
156
- protected readonly configure: _alepha_core.HookDescriptor<"configure">;
157
- protected readonly start: _alepha_core.HookDescriptor<"start">;
158
- protected readonly stop: _alepha_core.HookDescriptor<"stop">;
159
- protected createContextId(): string;
160
- /**
161
- * Get the schedulers.
162
- */
163
- getSchedulers(): Scheduler[];
164
- /**
165
- * Process scheduler descriptors.
166
- *
167
- * @protected
168
- */
169
- protected processSchedulerDescriptors(): void;
170
- /**
171
- * Create a scheduler.
172
- *
173
- * @param options - The scheduler options.
174
- * @param instance - The instance of the scheduler.
175
- * @param key - Property key name.
176
- * @protected
177
- */
178
- protected createScheduler(options: SchedulerDescriptorOptions, instance: any, key: string): Scheduler;
179
- protected createHandler(name: string, options: SchedulerDescriptorOptions): (args: SchedulerHandlerArguments) => Promise<void>;
180
- trigger(name: string): Promise<void>;
181
- protected runLock: _alepha_lock.LockDescriptor<(options: SchedulerDescriptorOptions & {
182
- name: string;
183
- args: SchedulerHandlerArguments;
184
- }) => Promise<void>>;
185
- /**
186
- * Prefix the scheduler key.
187
- */
188
- protected prefix(key: string): string;
189
- /**
190
- *
191
- * @param options
192
- * @protected
193
- */
194
- protected getLockGracePeriod(options: SchedulerDescriptorOptions): number;
89
+ protected readonly log: _alepha_core2.Logger;
90
+ protected readonly env: {
91
+ SCHEDULER_PREFIX?: string | undefined;
92
+ };
93
+ protected readonly alepha: Alepha;
94
+ protected readonly dateTimeProvider: DateTimeProvider;
95
+ protected readonly cronProvider: CronProvider;
96
+ protected readonly schedulers: Scheduler[];
97
+ protected readonly configure: _alepha_core2.HookDescriptor<"configure">;
98
+ protected readonly start: _alepha_core2.HookDescriptor<"start">;
99
+ protected readonly stop: _alepha_core2.HookDescriptor<"stop">;
100
+ protected createContextId(): string;
101
+ /**
102
+ * Get the schedulers.
103
+ */
104
+ getSchedulers(): Scheduler[];
105
+ /**
106
+ * Process scheduler descriptors.
107
+ *
108
+ * @protected
109
+ */
110
+ protected processSchedulerDescriptors(): void;
111
+ /**
112
+ * Create a scheduler.
113
+ *
114
+ * @param options - The scheduler options.
115
+ * @param instance - The instance of the scheduler.
116
+ * @param key - Property key name.
117
+ * @protected
118
+ */
119
+ protected createScheduler(options: SchedulerDescriptorOptions, instance: any, key: string): Scheduler;
120
+ protected createHandler(name: string, options: SchedulerDescriptorOptions): (args: SchedulerHandlerArguments) => Promise<void>;
121
+ trigger(name: string): Promise<void>;
122
+ protected runLock: _alepha_lock8.LockDescriptor<(options: SchedulerDescriptorOptions & {
123
+ name: string;
124
+ args: SchedulerHandlerArguments;
125
+ }) => Promise<void>>;
126
+ /**
127
+ * Prefix the scheduler key.
128
+ */
129
+ protected prefix(key: string): string;
130
+ /**
131
+ *
132
+ * @param options
133
+ * @protected
134
+ */
135
+ protected getLockGracePeriod(options: SchedulerDescriptorOptions): number;
195
136
  }
196
137
  interface Scheduler {
197
- name: string;
198
- options: SchedulerDescriptorOptions;
199
- trigger: (args: SchedulerHandlerArguments) => Promise<void>;
200
- cron?: CronJob;
201
- interval?: Interval;
138
+ name: string;
139
+ options: SchedulerDescriptorOptions;
140
+ trigger: (args: SchedulerHandlerArguments) => Promise<void>;
141
+ cron?: CronJob;
142
+ interval?: Interval;
202
143
  }
203
-
144
+ //#endregion
145
+ //#region src/index.d.ts
204
146
  /**
205
147
  * Alepha Scheduler Module
206
148
  *
@@ -210,8 +152,9 @@ interface Scheduler {
210
152
  * @module alepha.scheduler
211
153
  */
212
154
  declare class AlephaScheduler {
213
- readonly name = "alepha.scheduler";
214
- readonly $services: (alepha: Alepha) => Alepha;
155
+ readonly name = "alepha.scheduler";
156
+ readonly $services: (alepha: Alepha) => Alepha;
215
157
  }
216
-
217
- export { $scheduler, AlephaScheduler, type Scheduler, type SchedulerDescriptor, type SchedulerDescriptorOptions, SchedulerDescriptorProvider, type SchedulerHandlerArguments, isScheduler };
158
+ //#endregion
159
+ export { $scheduler, AlephaScheduler, Scheduler, SchedulerDescriptor, SchedulerDescriptorOptions, SchedulerDescriptorProvider, SchedulerHandlerArguments, isScheduler };
160
+ //# sourceMappingURL=index.d.ts.map
package/scheduler.js CHANGED
@@ -1 +1 @@
1
- export * from '@alepha/scheduler';
1
+ export * from '@alepha/scheduler'
package/security.cjs CHANGED
@@ -1,12 +1,8 @@
1
1
  'use strict';
2
-
3
- var security = require('@alepha/security');
4
-
5
-
6
-
7
- Object.keys(security).forEach(function (k) {
2
+ var m = require('@alepha/security');
3
+ Object.keys(m).forEach(function (k) {
8
4
  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
9
5
  enumerable: true,
10
- get: function () { return security[k]; }
6
+ get: function () { return m[k]; }
11
7
  });
12
- });
8
+ });