@vercel/schedules 0.0.0-alpha.0 → 0.0.0-alpha.10
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 +86 -2
- package/dist/index.cjs +254 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +149 -2
- package/dist/index.d.ts +149 -2
- package/dist/index.js +254 -4
- package/dist/index.js.map +1 -1
- package/package.json +4 -1
package/README.md
CHANGED
|
@@ -5,7 +5,91 @@ npm install @vercel/schedules
|
|
|
5
5
|
```
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
import {
|
|
8
|
+
import { Schedules } from '@vercel/schedules';
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
await Schedules.create({
|
|
11
|
+
name: 'cleanup',
|
|
12
|
+
target: { topic: 'scheduled-cleanup' },
|
|
13
|
+
expression: { type: 'cron', cron: '0 * * * *' },
|
|
14
|
+
});
|
|
11
15
|
```
|
|
16
|
+
|
|
17
|
+
## Schedule in a timezone
|
|
18
|
+
|
|
19
|
+
Set `timezone` to an IANA timezone to evaluate a cron expression in local time. For example, run a schedule at 9 AM Pacific time each day:
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { Schedules } from '@vercel/schedules';
|
|
23
|
+
|
|
24
|
+
await Schedules.create({
|
|
25
|
+
name: 'daily-cleanup',
|
|
26
|
+
target: { topic: 'scheduled-cleanup' },
|
|
27
|
+
expression: { type: 'cron', cron: '0 9 * * *' },
|
|
28
|
+
timezone: 'America/Los_Angeles',
|
|
29
|
+
});
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Omitting `timezone` uses UTC. Named timezones follow daylight-saving changes.
|
|
33
|
+
|
|
34
|
+
For a one-time schedule, pass `at` in `YYYY-MM-DDTHH:mm` or `YYYY-MM-DDTHH:mm:00` format. The datetime has no timezone information; set `timezone` separately or omit it to use UTC:
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
await Schedules.create({
|
|
38
|
+
name: 'one-time-cleanup',
|
|
39
|
+
target: { topic: 'scheduled-cleanup' },
|
|
40
|
+
expression: { type: 'single', at: '2026-09-16T09:00' },
|
|
41
|
+
timezone: 'America/Los_Angeles',
|
|
42
|
+
});
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
This schedules one invocation at 9 AM Pacific on September 16. The `at` field does not accept `Z`, numeric offsets, fractional seconds, or non-zero seconds. Omitted seconds are stored as `:00`.
|
|
46
|
+
|
|
47
|
+
Schedules returned by `get()` and `list()` include the IANA timezone.
|
|
48
|
+
|
|
49
|
+
Update schedule configuration by name and optional namespace:
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
await Schedules.update({
|
|
53
|
+
name: 'cleanup',
|
|
54
|
+
expression: { type: 'cron', cron: '0 2 * * *' },
|
|
55
|
+
payload: { maxAgeDays: 30 },
|
|
56
|
+
});
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Use `Schedules.enable` and `Schedules.disable` to change schedule state.
|
|
60
|
+
|
|
61
|
+
Invoke a schedule immediately:
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
await Schedules.invoke({ name: 'cleanup' });
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
The method returns once the asynchronous invocation has been accepted.
|
|
68
|
+
|
|
69
|
+
## Handle a scheduled function
|
|
70
|
+
|
|
71
|
+
Use `handleSchedule` in a function targeted by a schedule:
|
|
72
|
+
|
|
73
|
+
```ts
|
|
74
|
+
// api/cleanup.ts
|
|
75
|
+
import { handleSchedule } from '@vercel/schedules';
|
|
76
|
+
|
|
77
|
+
export const POST = handleSchedule(async (metadata) => {
|
|
78
|
+
console.log(`Running ${metadata.name}, scheduled at ${metadata.scheduledAt}`);
|
|
79
|
+
await deleteExpiredRecords();
|
|
80
|
+
});
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
The handler receives metadata about the current firing. It returns a `200` response when the callback completes successfully.
|
|
84
|
+
|
|
85
|
+
For a custom client:
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
import { SchedulesClient } from '@vercel/schedules';
|
|
89
|
+
|
|
90
|
+
const schedules = new SchedulesClient();
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The default client connects to the Vercel Schedules API at `https://vercel-schedules.com`. Override the endpoint with `baseUrl` or `VERCEL_SCHEDULE_BASE_URL`.
|
|
94
|
+
|
|
95
|
+
Requests are authenticated with the Vercel OIDC token from `@vercel/oidc`, or an explicit `token` option.
|
package/dist/index.cjs
CHANGED
|
@@ -1,8 +1,258 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/api-client.ts
|
|
2
|
+
var _oidc = require('@vercel/oidc');
|
|
3
|
+
|
|
4
|
+
// src/constants.ts
|
|
5
|
+
var DEFAULT_SCHEDULES_BASE_URL = "https://vercel-schedules.com";
|
|
6
|
+
|
|
7
|
+
// src/api-client.ts
|
|
8
|
+
var SchedulesApiError = class extends Error {
|
|
9
|
+
constructor(status, message) {
|
|
10
|
+
super(message);
|
|
11
|
+
this.name = "SchedulesApiError";
|
|
12
|
+
this.status = status;
|
|
13
|
+
}
|
|
14
|
+
};
|
|
15
|
+
var SchedulesApiClient = class {
|
|
16
|
+
constructor(options = {}) {
|
|
17
|
+
var _a, _b, _c;
|
|
18
|
+
this.baseUrl = new URL(
|
|
19
|
+
(_b = (_a = options.baseUrl) != null ? _a : process.env.VERCEL_SCHEDULE_BASE_URL) != null ? _b : DEFAULT_SCHEDULES_BASE_URL
|
|
20
|
+
);
|
|
21
|
+
this.token = options.token;
|
|
22
|
+
this.fetchImpl = (_c = options.fetch) != null ? _c : fetch;
|
|
23
|
+
}
|
|
24
|
+
async getToken() {
|
|
25
|
+
if (this.token) {
|
|
26
|
+
return this.token;
|
|
27
|
+
}
|
|
28
|
+
try {
|
|
29
|
+
return await _oidc.getVercelOidcToken.call(void 0, );
|
|
30
|
+
} catch (err) {
|
|
31
|
+
const cause = err instanceof Error ? err.message : String(err);
|
|
32
|
+
const isDev = process.env.NODE_ENV === "development";
|
|
33
|
+
throw new Error(
|
|
34
|
+
isDev ? `Failed to get OIDC token for local development.
|
|
35
|
+
|
|
36
|
+
To fix this, pull your environment variables with Vercel CLI:
|
|
37
|
+
\`vercel env pull\`
|
|
38
|
+
|
|
39
|
+
Cause: ${cause}` : `Failed to get OIDC token. This usually means the function is running outside of a Vercel Function environment.
|
|
40
|
+
|
|
41
|
+
To fix this, either:
|
|
42
|
+
- Deploy to Vercel (OIDC tokens are provisioned automatically)
|
|
43
|
+
- Provide a token explicitly: \`new Schedules({ token: "..." })\`
|
|
44
|
+
|
|
45
|
+
Cause: ${cause}`
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
async request(method, path, body) {
|
|
50
|
+
const headers = new Headers({
|
|
51
|
+
Authorization: `Bearer ${await this.getToken()}`
|
|
52
|
+
});
|
|
53
|
+
if (body !== void 0) {
|
|
54
|
+
headers.set("Content-Type", "application/json");
|
|
55
|
+
}
|
|
56
|
+
const response = await this.fetchImpl(new URL(path, this.baseUrl), {
|
|
57
|
+
method,
|
|
58
|
+
headers,
|
|
59
|
+
body: body === void 0 ? void 0 : JSON.stringify(body)
|
|
60
|
+
});
|
|
61
|
+
if (!response.ok) {
|
|
62
|
+
const text = await response.text();
|
|
63
|
+
throw new SchedulesApiError(response.status, text || response.statusText);
|
|
64
|
+
}
|
|
65
|
+
if (response.status === 204) {
|
|
66
|
+
return void 0;
|
|
67
|
+
}
|
|
68
|
+
return await response.json();
|
|
69
|
+
}
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
// src/schedules.ts
|
|
73
|
+
function schedulePath(name, namespace, suffix = "") {
|
|
74
|
+
const searchParams = new URLSearchParams();
|
|
75
|
+
if (namespace !== void 0) {
|
|
76
|
+
searchParams.set("namespace", namespace);
|
|
77
|
+
}
|
|
78
|
+
const query = searchParams.toString();
|
|
79
|
+
const path = `/v1/schedules/${encodeURIComponent(name)}${suffix}`;
|
|
80
|
+
return query ? `${path}?${query}` : path;
|
|
4
81
|
}
|
|
82
|
+
var SchedulesClient = class extends SchedulesApiClient {
|
|
83
|
+
create({
|
|
84
|
+
target,
|
|
85
|
+
...params
|
|
86
|
+
}) {
|
|
87
|
+
return this.request("POST", "/v1/schedules", {
|
|
88
|
+
...params,
|
|
89
|
+
target: {
|
|
90
|
+
type: "queue",
|
|
91
|
+
topic: target.topic
|
|
92
|
+
}
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
list(params = {}) {
|
|
96
|
+
const searchParams = new URLSearchParams();
|
|
97
|
+
if (params.namespace !== void 0) {
|
|
98
|
+
searchParams.set("namespace", params.namespace);
|
|
99
|
+
}
|
|
100
|
+
if (params.cursor !== void 0) {
|
|
101
|
+
searchParams.set("cursor", params.cursor);
|
|
102
|
+
}
|
|
103
|
+
if (params.limit !== void 0) {
|
|
104
|
+
searchParams.set("limit", String(params.limit));
|
|
105
|
+
}
|
|
106
|
+
const query = searchParams.toString();
|
|
107
|
+
const path = query ? `/v1/schedules?${query}` : "/v1/schedules";
|
|
108
|
+
return this.request("GET", path);
|
|
109
|
+
}
|
|
110
|
+
get({ name, namespace }) {
|
|
111
|
+
return this.request("GET", schedulePath(name, namespace));
|
|
112
|
+
}
|
|
113
|
+
update({
|
|
114
|
+
name,
|
|
115
|
+
namespace,
|
|
116
|
+
target,
|
|
117
|
+
...params
|
|
118
|
+
}) {
|
|
119
|
+
return this.request("PATCH", schedulePath(name, namespace), {
|
|
120
|
+
...params,
|
|
121
|
+
...target === void 0 ? {} : {
|
|
122
|
+
target: {
|
|
123
|
+
type: "queue",
|
|
124
|
+
topic: target.topic
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
async delete({ name, namespace }) {
|
|
130
|
+
await this.request("DELETE", schedulePath(name, namespace));
|
|
131
|
+
}
|
|
132
|
+
enable({ name, namespace }) {
|
|
133
|
+
return this.request("POST", schedulePath(name, namespace, "/enable"));
|
|
134
|
+
}
|
|
135
|
+
disable({ name, namespace }) {
|
|
136
|
+
return this.request("POST", schedulePath(name, namespace, "/disable"));
|
|
137
|
+
}
|
|
138
|
+
async invoke({ name, namespace }) {
|
|
139
|
+
await this.request("POST", schedulePath(name, namespace, "/invoke"));
|
|
140
|
+
}
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
// src/default-client.ts
|
|
144
|
+
var schedules = new SchedulesClient();
|
|
145
|
+
|
|
146
|
+
// src/schedule-event.ts
|
|
147
|
+
var SCHEDULE_CLOUD_EVENT_TYPE = "com.vercel.schedule.v1beta";
|
|
148
|
+
var CLOUD_EVENT_SPEC_VERSION_HEADER = "ce-specversion";
|
|
149
|
+
var CLOUD_EVENT_TYPE_HEADER = "ce-type";
|
|
150
|
+
var CLOUD_EVENT_SOURCE_HEADER = "ce-source";
|
|
151
|
+
var CLOUD_EVENT_ID_HEADER = "ce-id";
|
|
152
|
+
var SCHEDULE_SCHEDULED_AT_HEADER = "ce-vssscheduledat";
|
|
153
|
+
var SCHEDULE_ID_HEADER = "ce-vssscheduleid";
|
|
154
|
+
var SCHEDULE_NAME_HEADER = "ce-vssschedulename";
|
|
155
|
+
var SCHEDULE_NAMESPACE_HEADER = "ce-vssnamespace";
|
|
156
|
+
var SCHEDULE_SOURCE_HEADER = "ce-vssschedulesource";
|
|
157
|
+
var ScheduleEventParseError = class extends Error {
|
|
158
|
+
constructor(message, options) {
|
|
159
|
+
super(message);
|
|
160
|
+
this.name = "ScheduleEventParseError";
|
|
161
|
+
if (options && "cause" in options) {
|
|
162
|
+
this.cause = options.cause;
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
};
|
|
166
|
+
function requiredHeader(request, name) {
|
|
167
|
+
const value = request.headers.get(name);
|
|
168
|
+
if (!value) {
|
|
169
|
+
throw new ScheduleEventParseError(
|
|
170
|
+
`Request is missing the ${name} header; it does not look like a schedule dispatch`
|
|
171
|
+
);
|
|
172
|
+
}
|
|
173
|
+
return value;
|
|
174
|
+
}
|
|
175
|
+
async function parseScheduleEvent(request) {
|
|
176
|
+
if (request.method !== "POST") {
|
|
177
|
+
throw new ScheduleEventParseError(
|
|
178
|
+
`Schedule dispatches are POST requests, received ${request.method}`
|
|
179
|
+
);
|
|
180
|
+
}
|
|
181
|
+
const specVersion = requiredHeader(request, CLOUD_EVENT_SPEC_VERSION_HEADER);
|
|
182
|
+
if (specVersion !== "1.0") {
|
|
183
|
+
throw new ScheduleEventParseError(
|
|
184
|
+
`Unsupported CloudEvent spec version: ${specVersion}`
|
|
185
|
+
);
|
|
186
|
+
}
|
|
187
|
+
const eventType = requiredHeader(request, CLOUD_EVENT_TYPE_HEADER);
|
|
188
|
+
if (eventType !== SCHEDULE_CLOUD_EVENT_TYPE) {
|
|
189
|
+
throw new ScheduleEventParseError(
|
|
190
|
+
`Unsupported schedule CloudEvent type: ${eventType}`
|
|
191
|
+
);
|
|
192
|
+
}
|
|
193
|
+
requiredHeader(request, CLOUD_EVENT_SOURCE_HEADER);
|
|
194
|
+
const executionId = requiredHeader(request, CLOUD_EVENT_ID_HEADER);
|
|
195
|
+
const scheduledAtValue = requiredHeader(
|
|
196
|
+
request,
|
|
197
|
+
SCHEDULE_SCHEDULED_AT_HEADER
|
|
198
|
+
);
|
|
199
|
+
const metadata = {
|
|
200
|
+
scheduleId: requiredHeader(request, SCHEDULE_ID_HEADER),
|
|
201
|
+
executionId,
|
|
202
|
+
name: requiredHeader(request, SCHEDULE_NAME_HEADER),
|
|
203
|
+
namespace: requiredHeader(request, SCHEDULE_NAMESPACE_HEADER),
|
|
204
|
+
scheduledAt: new Date(scheduledAtValue),
|
|
205
|
+
source: requiredHeader(request, SCHEDULE_SOURCE_HEADER)
|
|
206
|
+
};
|
|
207
|
+
if (Number.isNaN(metadata.scheduledAt.getTime())) {
|
|
208
|
+
throw new ScheduleEventParseError(
|
|
209
|
+
`Schedule scheduledAt is not a valid timestamp: ${scheduledAtValue}`
|
|
210
|
+
);
|
|
211
|
+
}
|
|
212
|
+
return metadata;
|
|
213
|
+
}
|
|
214
|
+
function handleSchedule(handler) {
|
|
215
|
+
return async (request) => {
|
|
216
|
+
let metadata;
|
|
217
|
+
try {
|
|
218
|
+
metadata = await parseScheduleEvent(request);
|
|
219
|
+
} catch (error) {
|
|
220
|
+
if (error instanceof ScheduleEventParseError) {
|
|
221
|
+
return Response.json({ error: error.message }, { status: 400 });
|
|
222
|
+
}
|
|
223
|
+
return Response.json(
|
|
224
|
+
{ error: "Failed to parse schedule dispatch" },
|
|
225
|
+
{ status: 500 }
|
|
226
|
+
);
|
|
227
|
+
}
|
|
228
|
+
try {
|
|
229
|
+
await handler(metadata);
|
|
230
|
+
return new Response(null, { status: 200 });
|
|
231
|
+
} catch (e) {
|
|
232
|
+
return Response.json(
|
|
233
|
+
{ error: "Schedule handler failed" },
|
|
234
|
+
{ status: 500 }
|
|
235
|
+
);
|
|
236
|
+
}
|
|
237
|
+
};
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
5
255
|
|
|
6
256
|
|
|
7
|
-
exports.
|
|
257
|
+
exports.CLOUD_EVENT_ID_HEADER = CLOUD_EVENT_ID_HEADER; exports.CLOUD_EVENT_SOURCE_HEADER = CLOUD_EVENT_SOURCE_HEADER; exports.CLOUD_EVENT_SPEC_VERSION_HEADER = CLOUD_EVENT_SPEC_VERSION_HEADER; exports.CLOUD_EVENT_TYPE_HEADER = CLOUD_EVENT_TYPE_HEADER; exports.DEFAULT_SCHEDULES_BASE_URL = DEFAULT_SCHEDULES_BASE_URL; exports.SCHEDULE_CLOUD_EVENT_TYPE = SCHEDULE_CLOUD_EVENT_TYPE; exports.SCHEDULE_ID_HEADER = SCHEDULE_ID_HEADER; exports.SCHEDULE_NAMESPACE_HEADER = SCHEDULE_NAMESPACE_HEADER; exports.SCHEDULE_NAME_HEADER = SCHEDULE_NAME_HEADER; exports.SCHEDULE_SCHEDULED_AT_HEADER = SCHEDULE_SCHEDULED_AT_HEADER; exports.SCHEDULE_SOURCE_HEADER = SCHEDULE_SOURCE_HEADER; exports.ScheduleEventParseError = ScheduleEventParseError; exports.Schedules = schedules; exports.SchedulesApiError = SchedulesApiError; exports.SchedulesClient = SchedulesClient; exports.handleSchedule = handleSchedule; exports.parseScheduleEvent = parseScheduleEvent;
|
|
8
258
|
//# sourceMappingURL=index.cjs.map
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["/home/runner/work/schedules/schedules/packages/schedules/dist/index.cjs","../src/index.ts"],"names":[],"mappings":"AAAA;ACAO,SAAS,UAAA,CAAA,EAAmB;AACjC,EAAA,OAAA,CAAQ,GAAA,CAAI,aAAa,CAAA;AAC3B;ADEA;AACE;AACF,gCAAC","file":"/home/runner/work/schedules/schedules/packages/schedules/dist/index.cjs","sourcesContent":[null,"export function helloWorld(): void {\n console.log('hello world');\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["/home/runner/work/schedules/schedules/packages/schedules/dist/index.cjs","../src/api-client.ts","../src/constants.ts","../src/schedules.ts","../src/default-client.ts","../src/schedule-event.ts"],"names":[],"mappings":"AAAA;ACAA,oCAAmC;ADEnC;AACA;AEHO,IAAM,2BAAA,EAA6B,8BAAA;AFK1C;AACA;ACGO,IAAM,kBAAA,EAAN,MAAA,QAAgC,MAAM;AAAA,EAG3C,WAAA,CAAY,MAAA,EAAgB,OAAA,EAAiB;AAC3C,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,KAAA,EAAO,mBAAA;AACZ,IAAA,IAAA,CAAK,OAAA,EAAS,MAAA;AAAA,EAChB;AACF,CAAA;AAEO,IAAM,mBAAA,EAAN,MAAyB;AAAA,EAK9B,WAAA,CAAY,QAAA,EAAqC,CAAC,CAAA,EAAG;AAxBvD,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA;AAyBI,IAAA,IAAA,CAAK,QAAA,EAAU,IAAI,GAAA;AAAA,MAAA,CACjB,GAAA,EAAA,CAAA,GAAA,EAAA,OAAA,CAAQ,OAAA,EAAA,GAAR,KAAA,EAAA,GAAA,EACE,OAAA,CAAQ,GAAA,CAAI,wBAAA,EAAA,GADd,KAAA,EAAA,GAAA,EAEE;AAAA,IACJ,CAAA;AACA,IAAA,IAAA,CAAK,MAAA,EAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,UAAA,EAAA,CAAY,GAAA,EAAA,OAAA,CAAQ,KAAA,EAAA,GAAR,KAAA,EAAA,GAAA,EAAiB,KAAA;AAAA,EACpC;AAAA,EAEA,MAAgB,QAAA,CAAA,EAA4B;AAC1C,IAAA,GAAA,CAAI,IAAA,CAAK,KAAA,EAAO;AACd,MAAA,OAAO,IAAA,CAAK,KAAA;AAAA,IACd;AAEA,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,sCAAA,CAAmB;AAAA,IAClC,EAAA,MAAA,CAAS,GAAA,EAAK;AACZ,MAAA,MAAM,MAAA,EAAQ,IAAA,WAAe,MAAA,EAAQ,GAAA,CAAI,QAAA,EAAU,MAAA,CAAO,GAAG,CAAA;AAC7D,MAAA,MAAM,MAAA,EAAQ,OAAA,CAAQ,GAAA,CAAI,SAAA,IAAa,aAAA;AAEvC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,MAAA,EACI,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,OAAA,EAGY,KAAK,CAAA,EAAA;AACjB;AAAA;AAAA;AAAA;AAAA;AAKiB,OAAA;AACvB,MAAA;AACF,IAAA;AACF,EAAA;AAEgB,EAAA;AAKR,IAAA;AACJ,MAAA;AACD,IAAA;AAEG,IAAA;AACM,MAAA;AACV,IAAA;AAEM,IAAA;AACJ,MAAA;AACA,MAAA;AACM,MAAA;AACP,IAAA;AAEI,IAAA;AACG,MAAA;AACA,MAAA;AACR,IAAA;AAEI,IAAA;AACK,MAAA;AACT,IAAA;AAEQ,IAAA;AACV,EAAA;AACF;ADrBe;AACA;AG1DN;AACD,EAAA;AAEF,EAAA;AACF,IAAA;AACF,EAAA;AAEM,EAAA;AACO,EAAA;AAEN,EAAA;AACT;AAEa;AACJ,EAAA;AACL,IAAA;AACG,IAAA;AACqD,EAAA;AACjD,IAAA;AACF,MAAA;AACK,MAAA;AACA,QAAA;AACC,QAAA;AACT,MAAA;AACD,IAAA;AACH,EAAA;AAEK,EAAA;AACG,IAAA;AAEK,IAAA;AACT,MAAA;AACF,IAAA;AACW,IAAA;AACT,MAAA;AACF,IAAA;AACW,IAAA;AACT,MAAA;AACF,IAAA;AAEM,IAAA;AACA,IAAA;AAEC,IAAA;AACT,EAAA;AAEY,EAAA;AACH,IAAA;AACT,EAAA;AAEO,EAAA;AACL,IAAA;AACA,IAAA;AACA,IAAA;AACG,IAAA;AACqD,EAAA;AACjD,IAAA;AACF,MAAA;AACC,MAAA;AAGE,QAAA;AACE,UAAA;AACA,UAAA;AACF,QAAA;AACF,MAAA;AACL,IAAA;AACH,EAAA;AAEa,EAAA;AACA,IAAA;AACb,EAAA;AAES,EAAA;AACA,IAAA;AACT,EAAA;AAEU,EAAA;AACD,IAAA;AACT,EAAA;AAEa,EAAA;AACA,IAAA;AACb,EAAA;AACF;AH4Ce;AACA;AI5IF;AJ8IE;AACA;AKhJF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAwBA;AAGC,EAAA;AACJ,IAAA;AACD,IAAA;AACD,IAAA;AACG,MAAA;AACP,IAAA;AACF,EAAA;AACF;AAES;AACD,EAAA;AACM,EAAA;AACA,IAAA;AACR,MAAA;AACF,IAAA;AACF,EAAA;AACO,EAAA;AACT;AAGsB;AAGR,EAAA;AACA,IAAA;AACR,MAAA;AACF,IAAA;AACF,EAAA;AAEM,EAAA;AACF,EAAA;AACQ,IAAA;AACR,MAAA;AACF,IAAA;AACF,EAAA;AAEM,EAAA;AACF,EAAA;AACQ,IAAA;AACR,MAAA;AACF,IAAA;AACF,EAAA;AAEA,EAAA;AACM,EAAA;AACA,EAAA;AACJ,IAAA;AACA,IAAA;AACF,EAAA;AACM,EAAA;AACJ,IAAA;AACA,IAAA;AACM,IAAA;AACK,IAAA;AACX,IAAA;AACQ,IAAA;AACV,EAAA;AAEW,EAAA;AACC,IAAA;AACR,MAAA;AACF,IAAA;AACF,EAAA;AAEO,EAAA;AACT;AAWgB;AAGP,EAAA;AACD,IAAA;AACA,IAAA;AACF,MAAA;AACO,IAAA;AACH,MAAA;AACK,QAAA;AACT,MAAA;AACO,MAAA;AACH,QAAA;AACA,QAAA;AACJ,MAAA;AACF,IAAA;AAEI,IAAA;AACI,MAAA;AACC,MAAA;AACD,IAAA;AACC,MAAA;AACH,QAAA;AACA,QAAA;AACJ,MAAA;AACF,IAAA;AACF,EAAA;AACF;ALkGe;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","file":"/home/runner/work/schedules/schedules/packages/schedules/dist/index.cjs","sourcesContent":[null,"import { getVercelOidcToken } from '@vercel/oidc';\nimport { DEFAULT_SCHEDULES_BASE_URL } from './constants';\n\nexport interface SchedulesApiClientOptions {\n baseUrl?: string;\n token?: string;\n fetch?: typeof fetch;\n}\n\nexport class SchedulesApiError extends Error {\n readonly status: number;\n\n constructor(status: number, message: string) {\n super(message);\n this.name = 'SchedulesApiError';\n this.status = status;\n }\n}\n\nexport class SchedulesApiClient {\n private readonly baseUrl: URL;\n private readonly token?: string;\n private readonly fetchImpl: typeof fetch;\n\n constructor(options: SchedulesApiClientOptions = {}) {\n this.baseUrl = new URL(\n options.baseUrl ??\n process.env.VERCEL_SCHEDULE_BASE_URL ??\n DEFAULT_SCHEDULES_BASE_URL,\n );\n this.token = options.token;\n this.fetchImpl = options.fetch ?? fetch;\n }\n\n protected async getToken(): Promise<string> {\n if (this.token) {\n return this.token;\n }\n\n try {\n return await getVercelOidcToken();\n } catch (err) {\n const cause = err instanceof Error ? err.message : String(err);\n const isDev = process.env.NODE_ENV === 'development';\n\n throw new Error(\n isDev\n ? 'Failed to get OIDC token for local development.\\n\\n' +\n 'To fix this, pull your environment variables with Vercel CLI:\\n' +\n ' `vercel env pull`\\n\\n' +\n `Cause: ${cause}`\n : 'Failed to get OIDC token. This usually means the function is running ' +\n 'outside of a Vercel Function environment.\\n\\n' +\n 'To fix this, either:\\n' +\n ' - Deploy to Vercel (OIDC tokens are provisioned automatically)\\n' +\n ' - Provide a token explicitly: `new Schedules({ token: \"...\" })`\\n\\n' +\n `Cause: ${cause}`,\n );\n }\n }\n\n protected async request<T>(\n method: string,\n path: string,\n body?: unknown,\n ): Promise<T> {\n const headers = new Headers({\n Authorization: `Bearer ${await this.getToken()}`,\n });\n\n if (body !== undefined) {\n headers.set('Content-Type', 'application/json');\n }\n\n const response = await this.fetchImpl(new URL(path, this.baseUrl), {\n method,\n headers,\n body: body === undefined ? undefined : JSON.stringify(body),\n });\n\n if (!response.ok) {\n const text = await response.text();\n throw new SchedulesApiError(response.status, text || response.statusText);\n }\n\n if (response.status === 204) {\n return undefined as T;\n }\n\n return (await response.json()) as T;\n }\n}\n","export const DEFAULT_SCHEDULES_BASE_URL = 'https://vercel-schedules.com';\n","import { SchedulesApiClient } from './api-client';\nimport type {\n CreateScheduleParams,\n CreateScheduleResponse,\n InvokeScheduleParams,\n ListSchedulesParams,\n ListSchedulesResponse,\n Schedule,\n ScheduleIdentifier,\n UpdateScheduleParams,\n UpdateScheduleResponse,\n} from './types';\n\nfunction schedulePath(name: string, namespace?: string, suffix = ''): string {\n const searchParams = new URLSearchParams();\n\n if (namespace !== undefined) {\n searchParams.set('namespace', namespace);\n }\n\n const query = searchParams.toString();\n const path = `/v1/schedules/${encodeURIComponent(name)}${suffix}`;\n\n return query ? `${path}?${query}` : path;\n}\n\nexport class SchedulesClient extends SchedulesApiClient {\n create({\n target,\n ...params\n }: CreateScheduleParams): Promise<CreateScheduleResponse> {\n return this.request('POST', '/v1/schedules', {\n ...params,\n target: {\n type: 'queue',\n topic: target.topic,\n },\n });\n }\n\n list(params: ListSchedulesParams = {}): Promise<ListSchedulesResponse> {\n const searchParams = new URLSearchParams();\n\n if (params.namespace !== undefined) {\n searchParams.set('namespace', params.namespace);\n }\n if (params.cursor !== undefined) {\n searchParams.set('cursor', params.cursor);\n }\n if (params.limit !== undefined) {\n searchParams.set('limit', String(params.limit));\n }\n\n const query = searchParams.toString();\n const path = query ? `/v1/schedules?${query}` : '/v1/schedules';\n\n return this.request('GET', path);\n }\n\n get({ name, namespace }: ScheduleIdentifier): Promise<Schedule> {\n return this.request('GET', schedulePath(name, namespace));\n }\n\n update({\n name,\n namespace,\n target,\n ...params\n }: UpdateScheduleParams): Promise<UpdateScheduleResponse> {\n return this.request('PATCH', schedulePath(name, namespace), {\n ...params,\n ...(target === undefined\n ? {}\n : {\n target: {\n type: 'queue',\n topic: target.topic,\n },\n }),\n });\n }\n\n async delete({ name, namespace }: ScheduleIdentifier): Promise<void> {\n await this.request('DELETE', schedulePath(name, namespace));\n }\n\n enable({ name, namespace }: ScheduleIdentifier): Promise<Schedule> {\n return this.request('POST', schedulePath(name, namespace, '/enable'));\n }\n\n disable({ name, namespace }: ScheduleIdentifier): Promise<Schedule> {\n return this.request('POST', schedulePath(name, namespace, '/disable'));\n }\n\n async invoke({ name, namespace }: InvokeScheduleParams): Promise<void> {\n await this.request('POST', schedulePath(name, namespace, '/invoke'));\n }\n}\n","import { SchedulesClient } from './schedules';\n\nexport const schedules = new SchedulesClient();\n","/** CloudEvent type used for schedule function dispatches. */\nexport const SCHEDULE_CLOUD_EVENT_TYPE = 'com.vercel.schedule.v1beta';\nexport const CLOUD_EVENT_SPEC_VERSION_HEADER = 'ce-specversion';\nexport const CLOUD_EVENT_TYPE_HEADER = 'ce-type';\nexport const CLOUD_EVENT_SOURCE_HEADER = 'ce-source';\nexport const CLOUD_EVENT_ID_HEADER = 'ce-id';\nexport const SCHEDULE_SCHEDULED_AT_HEADER = 'ce-vssscheduledat';\nexport const SCHEDULE_ID_HEADER = 'ce-vssscheduleid';\nexport const SCHEDULE_NAME_HEADER = 'ce-vssschedulename';\nexport const SCHEDULE_NAMESPACE_HEADER = 'ce-vssnamespace';\nexport const SCHEDULE_SOURCE_HEADER = 'ce-vssschedulesource';\n\nexport interface ScheduleMetadata {\n /** Unique identifier of the schedule. */\n scheduleId: string;\n /** Unique identifier for this schedule occurrence. */\n executionId: string;\n /** Schedule name, unique within its project and namespace. */\n name: string;\n /** Namespace the schedule belongs to. */\n namespace: string;\n /**\n * Nominal scheduled time for this occurrence, based on the schedule expression.\n * Does not account for jitter. The dispatch may arrive later within the jitter window.\n */\n scheduledAt: Date;\n /** How the schedule was defined, such as `static`. */\n source: string;\n}\n\nexport type ScheduleHandler = (\n metadata: ScheduleMetadata,\n) => void | Promise<void>;\n\nexport class ScheduleEventParseError extends Error {\n cause?: unknown;\n\n constructor(message: string, options?: { cause?: unknown }) {\n super(message);\n this.name = 'ScheduleEventParseError';\n if (options && 'cause' in options) {\n this.cause = options.cause;\n }\n }\n}\n\nfunction requiredHeader(request: Request, name: string): string {\n const value = request.headers.get(name);\n if (!value) {\n throw new ScheduleEventParseError(\n `Request is missing the ${name} header; it does not look like a schedule dispatch`,\n );\n }\n return value;\n}\n\n/** Parses schedule metadata from a binary-mode schedule CloudEvent. */\nexport async function parseScheduleEvent(\n request: Request,\n): Promise<ScheduleMetadata> {\n if (request.method !== 'POST') {\n throw new ScheduleEventParseError(\n `Schedule dispatches are POST requests, received ${request.method}`,\n );\n }\n\n const specVersion = requiredHeader(request, CLOUD_EVENT_SPEC_VERSION_HEADER);\n if (specVersion !== '1.0') {\n throw new ScheduleEventParseError(\n `Unsupported CloudEvent spec version: ${specVersion}`,\n );\n }\n\n const eventType = requiredHeader(request, CLOUD_EVENT_TYPE_HEADER);\n if (eventType !== SCHEDULE_CLOUD_EVENT_TYPE) {\n throw new ScheduleEventParseError(\n `Unsupported schedule CloudEvent type: ${eventType}`,\n );\n }\n\n requiredHeader(request, CLOUD_EVENT_SOURCE_HEADER);\n const executionId = requiredHeader(request, CLOUD_EVENT_ID_HEADER);\n const scheduledAtValue = requiredHeader(\n request,\n SCHEDULE_SCHEDULED_AT_HEADER,\n );\n const metadata: ScheduleMetadata = {\n scheduleId: requiredHeader(request, SCHEDULE_ID_HEADER),\n executionId,\n name: requiredHeader(request, SCHEDULE_NAME_HEADER),\n namespace: requiredHeader(request, SCHEDULE_NAMESPACE_HEADER),\n scheduledAt: new Date(scheduledAtValue),\n source: requiredHeader(request, SCHEDULE_SOURCE_HEADER),\n };\n\n if (Number.isNaN(metadata.scheduledAt.getTime())) {\n throw new ScheduleEventParseError(\n `Schedule scheduledAt is not a valid timestamp: ${scheduledAtValue}`,\n );\n }\n\n return metadata;\n}\n\n/**\n * Creates a web-standard route handler for schedule dispatches.\n *\n * ```ts\n * export const POST = handleSchedule(async (metadata) => {\n * console.log(metadata.name, metadata.scheduledAt);\n * });\n * ```\n */\nexport function handleSchedule(\n handler: ScheduleHandler,\n): (request: Request) => Promise<Response> {\n return async (request: Request): Promise<Response> => {\n let metadata: ScheduleMetadata;\n try {\n metadata = await parseScheduleEvent(request);\n } catch (error) {\n if (error instanceof ScheduleEventParseError) {\n return Response.json({ error: error.message }, { status: 400 });\n }\n return Response.json(\n { error: 'Failed to parse schedule dispatch' },\n { status: 500 },\n );\n }\n\n try {\n await handler(metadata);\n return new Response(null, { status: 200 });\n } catch {\n return Response.json(\n { error: 'Schedule handler failed' },\n { status: 500 },\n );\n }\n };\n}\n"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,3 +1,150 @@
|
|
|
1
|
-
|
|
1
|
+
interface SchedulesApiClientOptions {
|
|
2
|
+
baseUrl?: string;
|
|
3
|
+
token?: string;
|
|
4
|
+
fetch?: typeof fetch;
|
|
5
|
+
}
|
|
6
|
+
declare class SchedulesApiError extends Error {
|
|
7
|
+
readonly status: number;
|
|
8
|
+
constructor(status: number, message: string);
|
|
9
|
+
}
|
|
10
|
+
declare class SchedulesApiClient {
|
|
11
|
+
private readonly baseUrl;
|
|
12
|
+
private readonly token?;
|
|
13
|
+
private readonly fetchImpl;
|
|
14
|
+
constructor(options?: SchedulesApiClientOptions);
|
|
15
|
+
protected getToken(): Promise<string>;
|
|
16
|
+
protected request<T>(method: string, path: string, body?: unknown): Promise<T>;
|
|
17
|
+
}
|
|
2
18
|
|
|
3
|
-
|
|
19
|
+
declare const DEFAULT_SCHEDULES_BASE_URL = "https://vercel-schedules.com";
|
|
20
|
+
|
|
21
|
+
type ScheduleExpression = {
|
|
22
|
+
type: 'cron';
|
|
23
|
+
cron: string;
|
|
24
|
+
} | {
|
|
25
|
+
type: 'single';
|
|
26
|
+
/** Datetime in YYYY-MM-DDTHH:mm or YYYY-MM-DDTHH:mm:00 format, with no timezone suffix. */
|
|
27
|
+
at: string;
|
|
28
|
+
};
|
|
29
|
+
type ScheduleTarget = {
|
|
30
|
+
type: 'queue';
|
|
31
|
+
topic: string;
|
|
32
|
+
};
|
|
33
|
+
type CreateScheduleTarget = {
|
|
34
|
+
topic: string;
|
|
35
|
+
};
|
|
36
|
+
type ScheduleState = 'active' | 'inactive';
|
|
37
|
+
type ScheduleSource = 'static' | 'dynamic';
|
|
38
|
+
interface Schedule {
|
|
39
|
+
scheduleId: string;
|
|
40
|
+
ownerId: string;
|
|
41
|
+
projectId: string;
|
|
42
|
+
trackId: string;
|
|
43
|
+
name: string;
|
|
44
|
+
namespace: string;
|
|
45
|
+
expression: ScheduleExpression;
|
|
46
|
+
/** IANA timezone used for cron expressions and one-time schedules. */
|
|
47
|
+
timezone: string;
|
|
48
|
+
jitter?: number;
|
|
49
|
+
target: ScheduleTarget;
|
|
50
|
+
state: ScheduleState;
|
|
51
|
+
source: ScheduleSource;
|
|
52
|
+
createdAt: number;
|
|
53
|
+
updatedAt: number;
|
|
54
|
+
}
|
|
55
|
+
interface CreateScheduleParams {
|
|
56
|
+
name: string;
|
|
57
|
+
namespace?: string;
|
|
58
|
+
expression: ScheduleExpression;
|
|
59
|
+
/** IANA timezone for cron expressions and local one-time schedules. Defaults to UTC. */
|
|
60
|
+
timezone?: string;
|
|
61
|
+
jitter?: number;
|
|
62
|
+
target: CreateScheduleTarget;
|
|
63
|
+
payload?: unknown;
|
|
64
|
+
}
|
|
65
|
+
type CreateScheduleResponse = Schedule;
|
|
66
|
+
interface ScheduleIdentifier {
|
|
67
|
+
name: string;
|
|
68
|
+
namespace?: string;
|
|
69
|
+
}
|
|
70
|
+
interface UpdateScheduleParams extends ScheduleIdentifier {
|
|
71
|
+
expression?: ScheduleExpression;
|
|
72
|
+
timezone?: string;
|
|
73
|
+
jitter?: number | null;
|
|
74
|
+
target?: CreateScheduleTarget;
|
|
75
|
+
payload?: unknown;
|
|
76
|
+
}
|
|
77
|
+
type UpdateScheduleResponse = Schedule;
|
|
78
|
+
type InvokeScheduleParams = ScheduleIdentifier;
|
|
79
|
+
interface ListSchedulesParams {
|
|
80
|
+
namespace?: string;
|
|
81
|
+
cursor?: string;
|
|
82
|
+
limit?: number;
|
|
83
|
+
}
|
|
84
|
+
interface ListSchedulesResponse {
|
|
85
|
+
data: Schedule[];
|
|
86
|
+
cursor: string | null;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
declare class SchedulesClient extends SchedulesApiClient {
|
|
90
|
+
create({ target, ...params }: CreateScheduleParams): Promise<CreateScheduleResponse>;
|
|
91
|
+
list(params?: ListSchedulesParams): Promise<ListSchedulesResponse>;
|
|
92
|
+
get({ name, namespace }: ScheduleIdentifier): Promise<Schedule>;
|
|
93
|
+
update({ name, namespace, target, ...params }: UpdateScheduleParams): Promise<UpdateScheduleResponse>;
|
|
94
|
+
delete({ name, namespace }: ScheduleIdentifier): Promise<void>;
|
|
95
|
+
enable({ name, namespace }: ScheduleIdentifier): Promise<Schedule>;
|
|
96
|
+
disable({ name, namespace }: ScheduleIdentifier): Promise<Schedule>;
|
|
97
|
+
invoke({ name, namespace }: InvokeScheduleParams): Promise<void>;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
declare const schedules: SchedulesClient;
|
|
101
|
+
|
|
102
|
+
/** CloudEvent type used for schedule function dispatches. */
|
|
103
|
+
declare const SCHEDULE_CLOUD_EVENT_TYPE = "com.vercel.schedule.v1beta";
|
|
104
|
+
declare const CLOUD_EVENT_SPEC_VERSION_HEADER = "ce-specversion";
|
|
105
|
+
declare const CLOUD_EVENT_TYPE_HEADER = "ce-type";
|
|
106
|
+
declare const CLOUD_EVENT_SOURCE_HEADER = "ce-source";
|
|
107
|
+
declare const CLOUD_EVENT_ID_HEADER = "ce-id";
|
|
108
|
+
declare const SCHEDULE_SCHEDULED_AT_HEADER = "ce-vssscheduledat";
|
|
109
|
+
declare const SCHEDULE_ID_HEADER = "ce-vssscheduleid";
|
|
110
|
+
declare const SCHEDULE_NAME_HEADER = "ce-vssschedulename";
|
|
111
|
+
declare const SCHEDULE_NAMESPACE_HEADER = "ce-vssnamespace";
|
|
112
|
+
declare const SCHEDULE_SOURCE_HEADER = "ce-vssschedulesource";
|
|
113
|
+
interface ScheduleMetadata {
|
|
114
|
+
/** Unique identifier of the schedule. */
|
|
115
|
+
scheduleId: string;
|
|
116
|
+
/** Unique identifier for this schedule occurrence. */
|
|
117
|
+
executionId: string;
|
|
118
|
+
/** Schedule name, unique within its project and namespace. */
|
|
119
|
+
name: string;
|
|
120
|
+
/** Namespace the schedule belongs to. */
|
|
121
|
+
namespace: string;
|
|
122
|
+
/**
|
|
123
|
+
* Nominal scheduled time for this occurrence, based on the schedule expression.
|
|
124
|
+
* Does not account for jitter. The dispatch may arrive later within the jitter window.
|
|
125
|
+
*/
|
|
126
|
+
scheduledAt: Date;
|
|
127
|
+
/** How the schedule was defined, such as `static`. */
|
|
128
|
+
source: string;
|
|
129
|
+
}
|
|
130
|
+
type ScheduleHandler = (metadata: ScheduleMetadata) => void | Promise<void>;
|
|
131
|
+
declare class ScheduleEventParseError extends Error {
|
|
132
|
+
cause?: unknown;
|
|
133
|
+
constructor(message: string, options?: {
|
|
134
|
+
cause?: unknown;
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
/** Parses schedule metadata from a binary-mode schedule CloudEvent. */
|
|
138
|
+
declare function parseScheduleEvent(request: Request): Promise<ScheduleMetadata>;
|
|
139
|
+
/**
|
|
140
|
+
* Creates a web-standard route handler for schedule dispatches.
|
|
141
|
+
*
|
|
142
|
+
* ```ts
|
|
143
|
+
* export const POST = handleSchedule(async (metadata) => {
|
|
144
|
+
* console.log(metadata.name, metadata.scheduledAt);
|
|
145
|
+
* });
|
|
146
|
+
* ```
|
|
147
|
+
*/
|
|
148
|
+
declare function handleSchedule(handler: ScheduleHandler): (request: Request) => Promise<Response>;
|
|
149
|
+
|
|
150
|
+
export { CLOUD_EVENT_ID_HEADER, CLOUD_EVENT_SOURCE_HEADER, CLOUD_EVENT_SPEC_VERSION_HEADER, CLOUD_EVENT_TYPE_HEADER, type CreateScheduleParams, type CreateScheduleResponse, type CreateScheduleTarget, DEFAULT_SCHEDULES_BASE_URL, type InvokeScheduleParams, type ListSchedulesParams, type ListSchedulesResponse, SCHEDULE_CLOUD_EVENT_TYPE, SCHEDULE_ID_HEADER, SCHEDULE_NAMESPACE_HEADER, SCHEDULE_NAME_HEADER, SCHEDULE_SCHEDULED_AT_HEADER, SCHEDULE_SOURCE_HEADER, type Schedule, ScheduleEventParseError, type ScheduleExpression, type ScheduleHandler, type ScheduleIdentifier, type ScheduleMetadata, type ScheduleSource, type ScheduleState, type ScheduleTarget, schedules as Schedules, type SchedulesApiClientOptions, SchedulesApiError, SchedulesClient, type UpdateScheduleParams, type UpdateScheduleResponse, handleSchedule, parseScheduleEvent };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,150 @@
|
|
|
1
|
-
|
|
1
|
+
interface SchedulesApiClientOptions {
|
|
2
|
+
baseUrl?: string;
|
|
3
|
+
token?: string;
|
|
4
|
+
fetch?: typeof fetch;
|
|
5
|
+
}
|
|
6
|
+
declare class SchedulesApiError extends Error {
|
|
7
|
+
readonly status: number;
|
|
8
|
+
constructor(status: number, message: string);
|
|
9
|
+
}
|
|
10
|
+
declare class SchedulesApiClient {
|
|
11
|
+
private readonly baseUrl;
|
|
12
|
+
private readonly token?;
|
|
13
|
+
private readonly fetchImpl;
|
|
14
|
+
constructor(options?: SchedulesApiClientOptions);
|
|
15
|
+
protected getToken(): Promise<string>;
|
|
16
|
+
protected request<T>(method: string, path: string, body?: unknown): Promise<T>;
|
|
17
|
+
}
|
|
2
18
|
|
|
3
|
-
|
|
19
|
+
declare const DEFAULT_SCHEDULES_BASE_URL = "https://vercel-schedules.com";
|
|
20
|
+
|
|
21
|
+
type ScheduleExpression = {
|
|
22
|
+
type: 'cron';
|
|
23
|
+
cron: string;
|
|
24
|
+
} | {
|
|
25
|
+
type: 'single';
|
|
26
|
+
/** Datetime in YYYY-MM-DDTHH:mm or YYYY-MM-DDTHH:mm:00 format, with no timezone suffix. */
|
|
27
|
+
at: string;
|
|
28
|
+
};
|
|
29
|
+
type ScheduleTarget = {
|
|
30
|
+
type: 'queue';
|
|
31
|
+
topic: string;
|
|
32
|
+
};
|
|
33
|
+
type CreateScheduleTarget = {
|
|
34
|
+
topic: string;
|
|
35
|
+
};
|
|
36
|
+
type ScheduleState = 'active' | 'inactive';
|
|
37
|
+
type ScheduleSource = 'static' | 'dynamic';
|
|
38
|
+
interface Schedule {
|
|
39
|
+
scheduleId: string;
|
|
40
|
+
ownerId: string;
|
|
41
|
+
projectId: string;
|
|
42
|
+
trackId: string;
|
|
43
|
+
name: string;
|
|
44
|
+
namespace: string;
|
|
45
|
+
expression: ScheduleExpression;
|
|
46
|
+
/** IANA timezone used for cron expressions and one-time schedules. */
|
|
47
|
+
timezone: string;
|
|
48
|
+
jitter?: number;
|
|
49
|
+
target: ScheduleTarget;
|
|
50
|
+
state: ScheduleState;
|
|
51
|
+
source: ScheduleSource;
|
|
52
|
+
createdAt: number;
|
|
53
|
+
updatedAt: number;
|
|
54
|
+
}
|
|
55
|
+
interface CreateScheduleParams {
|
|
56
|
+
name: string;
|
|
57
|
+
namespace?: string;
|
|
58
|
+
expression: ScheduleExpression;
|
|
59
|
+
/** IANA timezone for cron expressions and local one-time schedules. Defaults to UTC. */
|
|
60
|
+
timezone?: string;
|
|
61
|
+
jitter?: number;
|
|
62
|
+
target: CreateScheduleTarget;
|
|
63
|
+
payload?: unknown;
|
|
64
|
+
}
|
|
65
|
+
type CreateScheduleResponse = Schedule;
|
|
66
|
+
interface ScheduleIdentifier {
|
|
67
|
+
name: string;
|
|
68
|
+
namespace?: string;
|
|
69
|
+
}
|
|
70
|
+
interface UpdateScheduleParams extends ScheduleIdentifier {
|
|
71
|
+
expression?: ScheduleExpression;
|
|
72
|
+
timezone?: string;
|
|
73
|
+
jitter?: number | null;
|
|
74
|
+
target?: CreateScheduleTarget;
|
|
75
|
+
payload?: unknown;
|
|
76
|
+
}
|
|
77
|
+
type UpdateScheduleResponse = Schedule;
|
|
78
|
+
type InvokeScheduleParams = ScheduleIdentifier;
|
|
79
|
+
interface ListSchedulesParams {
|
|
80
|
+
namespace?: string;
|
|
81
|
+
cursor?: string;
|
|
82
|
+
limit?: number;
|
|
83
|
+
}
|
|
84
|
+
interface ListSchedulesResponse {
|
|
85
|
+
data: Schedule[];
|
|
86
|
+
cursor: string | null;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
declare class SchedulesClient extends SchedulesApiClient {
|
|
90
|
+
create({ target, ...params }: CreateScheduleParams): Promise<CreateScheduleResponse>;
|
|
91
|
+
list(params?: ListSchedulesParams): Promise<ListSchedulesResponse>;
|
|
92
|
+
get({ name, namespace }: ScheduleIdentifier): Promise<Schedule>;
|
|
93
|
+
update({ name, namespace, target, ...params }: UpdateScheduleParams): Promise<UpdateScheduleResponse>;
|
|
94
|
+
delete({ name, namespace }: ScheduleIdentifier): Promise<void>;
|
|
95
|
+
enable({ name, namespace }: ScheduleIdentifier): Promise<Schedule>;
|
|
96
|
+
disable({ name, namespace }: ScheduleIdentifier): Promise<Schedule>;
|
|
97
|
+
invoke({ name, namespace }: InvokeScheduleParams): Promise<void>;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
declare const schedules: SchedulesClient;
|
|
101
|
+
|
|
102
|
+
/** CloudEvent type used for schedule function dispatches. */
|
|
103
|
+
declare const SCHEDULE_CLOUD_EVENT_TYPE = "com.vercel.schedule.v1beta";
|
|
104
|
+
declare const CLOUD_EVENT_SPEC_VERSION_HEADER = "ce-specversion";
|
|
105
|
+
declare const CLOUD_EVENT_TYPE_HEADER = "ce-type";
|
|
106
|
+
declare const CLOUD_EVENT_SOURCE_HEADER = "ce-source";
|
|
107
|
+
declare const CLOUD_EVENT_ID_HEADER = "ce-id";
|
|
108
|
+
declare const SCHEDULE_SCHEDULED_AT_HEADER = "ce-vssscheduledat";
|
|
109
|
+
declare const SCHEDULE_ID_HEADER = "ce-vssscheduleid";
|
|
110
|
+
declare const SCHEDULE_NAME_HEADER = "ce-vssschedulename";
|
|
111
|
+
declare const SCHEDULE_NAMESPACE_HEADER = "ce-vssnamespace";
|
|
112
|
+
declare const SCHEDULE_SOURCE_HEADER = "ce-vssschedulesource";
|
|
113
|
+
interface ScheduleMetadata {
|
|
114
|
+
/** Unique identifier of the schedule. */
|
|
115
|
+
scheduleId: string;
|
|
116
|
+
/** Unique identifier for this schedule occurrence. */
|
|
117
|
+
executionId: string;
|
|
118
|
+
/** Schedule name, unique within its project and namespace. */
|
|
119
|
+
name: string;
|
|
120
|
+
/** Namespace the schedule belongs to. */
|
|
121
|
+
namespace: string;
|
|
122
|
+
/**
|
|
123
|
+
* Nominal scheduled time for this occurrence, based on the schedule expression.
|
|
124
|
+
* Does not account for jitter. The dispatch may arrive later within the jitter window.
|
|
125
|
+
*/
|
|
126
|
+
scheduledAt: Date;
|
|
127
|
+
/** How the schedule was defined, such as `static`. */
|
|
128
|
+
source: string;
|
|
129
|
+
}
|
|
130
|
+
type ScheduleHandler = (metadata: ScheduleMetadata) => void | Promise<void>;
|
|
131
|
+
declare class ScheduleEventParseError extends Error {
|
|
132
|
+
cause?: unknown;
|
|
133
|
+
constructor(message: string, options?: {
|
|
134
|
+
cause?: unknown;
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
/** Parses schedule metadata from a binary-mode schedule CloudEvent. */
|
|
138
|
+
declare function parseScheduleEvent(request: Request): Promise<ScheduleMetadata>;
|
|
139
|
+
/**
|
|
140
|
+
* Creates a web-standard route handler for schedule dispatches.
|
|
141
|
+
*
|
|
142
|
+
* ```ts
|
|
143
|
+
* export const POST = handleSchedule(async (metadata) => {
|
|
144
|
+
* console.log(metadata.name, metadata.scheduledAt);
|
|
145
|
+
* });
|
|
146
|
+
* ```
|
|
147
|
+
*/
|
|
148
|
+
declare function handleSchedule(handler: ScheduleHandler): (request: Request) => Promise<Response>;
|
|
149
|
+
|
|
150
|
+
export { CLOUD_EVENT_ID_HEADER, CLOUD_EVENT_SOURCE_HEADER, CLOUD_EVENT_SPEC_VERSION_HEADER, CLOUD_EVENT_TYPE_HEADER, type CreateScheduleParams, type CreateScheduleResponse, type CreateScheduleTarget, DEFAULT_SCHEDULES_BASE_URL, type InvokeScheduleParams, type ListSchedulesParams, type ListSchedulesResponse, SCHEDULE_CLOUD_EVENT_TYPE, SCHEDULE_ID_HEADER, SCHEDULE_NAMESPACE_HEADER, SCHEDULE_NAME_HEADER, SCHEDULE_SCHEDULED_AT_HEADER, SCHEDULE_SOURCE_HEADER, type Schedule, ScheduleEventParseError, type ScheduleExpression, type ScheduleHandler, type ScheduleIdentifier, type ScheduleMetadata, type ScheduleSource, type ScheduleState, type ScheduleTarget, schedules as Schedules, type SchedulesApiClientOptions, SchedulesApiError, SchedulesClient, type UpdateScheduleParams, type UpdateScheduleResponse, handleSchedule, parseScheduleEvent };
|
package/dist/index.js
CHANGED
|
@@ -1,8 +1,258 @@
|
|
|
1
|
-
// src/
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
// src/api-client.ts
|
|
2
|
+
import { getVercelOidcToken } from "@vercel/oidc";
|
|
3
|
+
|
|
4
|
+
// src/constants.ts
|
|
5
|
+
var DEFAULT_SCHEDULES_BASE_URL = "https://vercel-schedules.com";
|
|
6
|
+
|
|
7
|
+
// src/api-client.ts
|
|
8
|
+
var SchedulesApiError = class extends Error {
|
|
9
|
+
constructor(status, message) {
|
|
10
|
+
super(message);
|
|
11
|
+
this.name = "SchedulesApiError";
|
|
12
|
+
this.status = status;
|
|
13
|
+
}
|
|
14
|
+
};
|
|
15
|
+
var SchedulesApiClient = class {
|
|
16
|
+
constructor(options = {}) {
|
|
17
|
+
var _a, _b, _c;
|
|
18
|
+
this.baseUrl = new URL(
|
|
19
|
+
(_b = (_a = options.baseUrl) != null ? _a : process.env.VERCEL_SCHEDULE_BASE_URL) != null ? _b : DEFAULT_SCHEDULES_BASE_URL
|
|
20
|
+
);
|
|
21
|
+
this.token = options.token;
|
|
22
|
+
this.fetchImpl = (_c = options.fetch) != null ? _c : fetch;
|
|
23
|
+
}
|
|
24
|
+
async getToken() {
|
|
25
|
+
if (this.token) {
|
|
26
|
+
return this.token;
|
|
27
|
+
}
|
|
28
|
+
try {
|
|
29
|
+
return await getVercelOidcToken();
|
|
30
|
+
} catch (err) {
|
|
31
|
+
const cause = err instanceof Error ? err.message : String(err);
|
|
32
|
+
const isDev = process.env.NODE_ENV === "development";
|
|
33
|
+
throw new Error(
|
|
34
|
+
isDev ? `Failed to get OIDC token for local development.
|
|
35
|
+
|
|
36
|
+
To fix this, pull your environment variables with Vercel CLI:
|
|
37
|
+
\`vercel env pull\`
|
|
38
|
+
|
|
39
|
+
Cause: ${cause}` : `Failed to get OIDC token. This usually means the function is running outside of a Vercel Function environment.
|
|
40
|
+
|
|
41
|
+
To fix this, either:
|
|
42
|
+
- Deploy to Vercel (OIDC tokens are provisioned automatically)
|
|
43
|
+
- Provide a token explicitly: \`new Schedules({ token: "..." })\`
|
|
44
|
+
|
|
45
|
+
Cause: ${cause}`
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
async request(method, path, body) {
|
|
50
|
+
const headers = new Headers({
|
|
51
|
+
Authorization: `Bearer ${await this.getToken()}`
|
|
52
|
+
});
|
|
53
|
+
if (body !== void 0) {
|
|
54
|
+
headers.set("Content-Type", "application/json");
|
|
55
|
+
}
|
|
56
|
+
const response = await this.fetchImpl(new URL(path, this.baseUrl), {
|
|
57
|
+
method,
|
|
58
|
+
headers,
|
|
59
|
+
body: body === void 0 ? void 0 : JSON.stringify(body)
|
|
60
|
+
});
|
|
61
|
+
if (!response.ok) {
|
|
62
|
+
const text = await response.text();
|
|
63
|
+
throw new SchedulesApiError(response.status, text || response.statusText);
|
|
64
|
+
}
|
|
65
|
+
if (response.status === 204) {
|
|
66
|
+
return void 0;
|
|
67
|
+
}
|
|
68
|
+
return await response.json();
|
|
69
|
+
}
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
// src/schedules.ts
|
|
73
|
+
function schedulePath(name, namespace, suffix = "") {
|
|
74
|
+
const searchParams = new URLSearchParams();
|
|
75
|
+
if (namespace !== void 0) {
|
|
76
|
+
searchParams.set("namespace", namespace);
|
|
77
|
+
}
|
|
78
|
+
const query = searchParams.toString();
|
|
79
|
+
const path = `/v1/schedules/${encodeURIComponent(name)}${suffix}`;
|
|
80
|
+
return query ? `${path}?${query}` : path;
|
|
81
|
+
}
|
|
82
|
+
var SchedulesClient = class extends SchedulesApiClient {
|
|
83
|
+
create({
|
|
84
|
+
target,
|
|
85
|
+
...params
|
|
86
|
+
}) {
|
|
87
|
+
return this.request("POST", "/v1/schedules", {
|
|
88
|
+
...params,
|
|
89
|
+
target: {
|
|
90
|
+
type: "queue",
|
|
91
|
+
topic: target.topic
|
|
92
|
+
}
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
list(params = {}) {
|
|
96
|
+
const searchParams = new URLSearchParams();
|
|
97
|
+
if (params.namespace !== void 0) {
|
|
98
|
+
searchParams.set("namespace", params.namespace);
|
|
99
|
+
}
|
|
100
|
+
if (params.cursor !== void 0) {
|
|
101
|
+
searchParams.set("cursor", params.cursor);
|
|
102
|
+
}
|
|
103
|
+
if (params.limit !== void 0) {
|
|
104
|
+
searchParams.set("limit", String(params.limit));
|
|
105
|
+
}
|
|
106
|
+
const query = searchParams.toString();
|
|
107
|
+
const path = query ? `/v1/schedules?${query}` : "/v1/schedules";
|
|
108
|
+
return this.request("GET", path);
|
|
109
|
+
}
|
|
110
|
+
get({ name, namespace }) {
|
|
111
|
+
return this.request("GET", schedulePath(name, namespace));
|
|
112
|
+
}
|
|
113
|
+
update({
|
|
114
|
+
name,
|
|
115
|
+
namespace,
|
|
116
|
+
target,
|
|
117
|
+
...params
|
|
118
|
+
}) {
|
|
119
|
+
return this.request("PATCH", schedulePath(name, namespace), {
|
|
120
|
+
...params,
|
|
121
|
+
...target === void 0 ? {} : {
|
|
122
|
+
target: {
|
|
123
|
+
type: "queue",
|
|
124
|
+
topic: target.topic
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
async delete({ name, namespace }) {
|
|
130
|
+
await this.request("DELETE", schedulePath(name, namespace));
|
|
131
|
+
}
|
|
132
|
+
enable({ name, namespace }) {
|
|
133
|
+
return this.request("POST", schedulePath(name, namespace, "/enable"));
|
|
134
|
+
}
|
|
135
|
+
disable({ name, namespace }) {
|
|
136
|
+
return this.request("POST", schedulePath(name, namespace, "/disable"));
|
|
137
|
+
}
|
|
138
|
+
async invoke({ name, namespace }) {
|
|
139
|
+
await this.request("POST", schedulePath(name, namespace, "/invoke"));
|
|
140
|
+
}
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
// src/default-client.ts
|
|
144
|
+
var schedules = new SchedulesClient();
|
|
145
|
+
|
|
146
|
+
// src/schedule-event.ts
|
|
147
|
+
var SCHEDULE_CLOUD_EVENT_TYPE = "com.vercel.schedule.v1beta";
|
|
148
|
+
var CLOUD_EVENT_SPEC_VERSION_HEADER = "ce-specversion";
|
|
149
|
+
var CLOUD_EVENT_TYPE_HEADER = "ce-type";
|
|
150
|
+
var CLOUD_EVENT_SOURCE_HEADER = "ce-source";
|
|
151
|
+
var CLOUD_EVENT_ID_HEADER = "ce-id";
|
|
152
|
+
var SCHEDULE_SCHEDULED_AT_HEADER = "ce-vssscheduledat";
|
|
153
|
+
var SCHEDULE_ID_HEADER = "ce-vssscheduleid";
|
|
154
|
+
var SCHEDULE_NAME_HEADER = "ce-vssschedulename";
|
|
155
|
+
var SCHEDULE_NAMESPACE_HEADER = "ce-vssnamespace";
|
|
156
|
+
var SCHEDULE_SOURCE_HEADER = "ce-vssschedulesource";
|
|
157
|
+
var ScheduleEventParseError = class extends Error {
|
|
158
|
+
constructor(message, options) {
|
|
159
|
+
super(message);
|
|
160
|
+
this.name = "ScheduleEventParseError";
|
|
161
|
+
if (options && "cause" in options) {
|
|
162
|
+
this.cause = options.cause;
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
};
|
|
166
|
+
function requiredHeader(request, name) {
|
|
167
|
+
const value = request.headers.get(name);
|
|
168
|
+
if (!value) {
|
|
169
|
+
throw new ScheduleEventParseError(
|
|
170
|
+
`Request is missing the ${name} header; it does not look like a schedule dispatch`
|
|
171
|
+
);
|
|
172
|
+
}
|
|
173
|
+
return value;
|
|
174
|
+
}
|
|
175
|
+
async function parseScheduleEvent(request) {
|
|
176
|
+
if (request.method !== "POST") {
|
|
177
|
+
throw new ScheduleEventParseError(
|
|
178
|
+
`Schedule dispatches are POST requests, received ${request.method}`
|
|
179
|
+
);
|
|
180
|
+
}
|
|
181
|
+
const specVersion = requiredHeader(request, CLOUD_EVENT_SPEC_VERSION_HEADER);
|
|
182
|
+
if (specVersion !== "1.0") {
|
|
183
|
+
throw new ScheduleEventParseError(
|
|
184
|
+
`Unsupported CloudEvent spec version: ${specVersion}`
|
|
185
|
+
);
|
|
186
|
+
}
|
|
187
|
+
const eventType = requiredHeader(request, CLOUD_EVENT_TYPE_HEADER);
|
|
188
|
+
if (eventType !== SCHEDULE_CLOUD_EVENT_TYPE) {
|
|
189
|
+
throw new ScheduleEventParseError(
|
|
190
|
+
`Unsupported schedule CloudEvent type: ${eventType}`
|
|
191
|
+
);
|
|
192
|
+
}
|
|
193
|
+
requiredHeader(request, CLOUD_EVENT_SOURCE_HEADER);
|
|
194
|
+
const executionId = requiredHeader(request, CLOUD_EVENT_ID_HEADER);
|
|
195
|
+
const scheduledAtValue = requiredHeader(
|
|
196
|
+
request,
|
|
197
|
+
SCHEDULE_SCHEDULED_AT_HEADER
|
|
198
|
+
);
|
|
199
|
+
const metadata = {
|
|
200
|
+
scheduleId: requiredHeader(request, SCHEDULE_ID_HEADER),
|
|
201
|
+
executionId,
|
|
202
|
+
name: requiredHeader(request, SCHEDULE_NAME_HEADER),
|
|
203
|
+
namespace: requiredHeader(request, SCHEDULE_NAMESPACE_HEADER),
|
|
204
|
+
scheduledAt: new Date(scheduledAtValue),
|
|
205
|
+
source: requiredHeader(request, SCHEDULE_SOURCE_HEADER)
|
|
206
|
+
};
|
|
207
|
+
if (Number.isNaN(metadata.scheduledAt.getTime())) {
|
|
208
|
+
throw new ScheduleEventParseError(
|
|
209
|
+
`Schedule scheduledAt is not a valid timestamp: ${scheduledAtValue}`
|
|
210
|
+
);
|
|
211
|
+
}
|
|
212
|
+
return metadata;
|
|
213
|
+
}
|
|
214
|
+
function handleSchedule(handler) {
|
|
215
|
+
return async (request) => {
|
|
216
|
+
let metadata;
|
|
217
|
+
try {
|
|
218
|
+
metadata = await parseScheduleEvent(request);
|
|
219
|
+
} catch (error) {
|
|
220
|
+
if (error instanceof ScheduleEventParseError) {
|
|
221
|
+
return Response.json({ error: error.message }, { status: 400 });
|
|
222
|
+
}
|
|
223
|
+
return Response.json(
|
|
224
|
+
{ error: "Failed to parse schedule dispatch" },
|
|
225
|
+
{ status: 500 }
|
|
226
|
+
);
|
|
227
|
+
}
|
|
228
|
+
try {
|
|
229
|
+
await handler(metadata);
|
|
230
|
+
return new Response(null, { status: 200 });
|
|
231
|
+
} catch {
|
|
232
|
+
return Response.json(
|
|
233
|
+
{ error: "Schedule handler failed" },
|
|
234
|
+
{ status: 500 }
|
|
235
|
+
);
|
|
236
|
+
}
|
|
237
|
+
};
|
|
4
238
|
}
|
|
5
239
|
export {
|
|
6
|
-
|
|
240
|
+
CLOUD_EVENT_ID_HEADER,
|
|
241
|
+
CLOUD_EVENT_SOURCE_HEADER,
|
|
242
|
+
CLOUD_EVENT_SPEC_VERSION_HEADER,
|
|
243
|
+
CLOUD_EVENT_TYPE_HEADER,
|
|
244
|
+
DEFAULT_SCHEDULES_BASE_URL,
|
|
245
|
+
SCHEDULE_CLOUD_EVENT_TYPE,
|
|
246
|
+
SCHEDULE_ID_HEADER,
|
|
247
|
+
SCHEDULE_NAMESPACE_HEADER,
|
|
248
|
+
SCHEDULE_NAME_HEADER,
|
|
249
|
+
SCHEDULE_SCHEDULED_AT_HEADER,
|
|
250
|
+
SCHEDULE_SOURCE_HEADER,
|
|
251
|
+
ScheduleEventParseError,
|
|
252
|
+
schedules as Schedules,
|
|
253
|
+
SchedulesApiError,
|
|
254
|
+
SchedulesClient,
|
|
255
|
+
handleSchedule,
|
|
256
|
+
parseScheduleEvent
|
|
7
257
|
};
|
|
8
258
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export function helloWorld(): void {\n console.log('hello world');\n}\n"],"mappings":";AAAO,SAAS,aAAmB;AACjC,UAAQ,IAAI,aAAa;AAC3B;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../src/api-client.ts","../src/constants.ts","../src/schedules.ts","../src/default-client.ts","../src/schedule-event.ts"],"sourcesContent":["import { getVercelOidcToken } from '@vercel/oidc';\nimport { DEFAULT_SCHEDULES_BASE_URL } from './constants';\n\nexport interface SchedulesApiClientOptions {\n baseUrl?: string;\n token?: string;\n fetch?: typeof fetch;\n}\n\nexport class SchedulesApiError extends Error {\n readonly status: number;\n\n constructor(status: number, message: string) {\n super(message);\n this.name = 'SchedulesApiError';\n this.status = status;\n }\n}\n\nexport class SchedulesApiClient {\n private readonly baseUrl: URL;\n private readonly token?: string;\n private readonly fetchImpl: typeof fetch;\n\n constructor(options: SchedulesApiClientOptions = {}) {\n this.baseUrl = new URL(\n options.baseUrl ??\n process.env.VERCEL_SCHEDULE_BASE_URL ??\n DEFAULT_SCHEDULES_BASE_URL,\n );\n this.token = options.token;\n this.fetchImpl = options.fetch ?? fetch;\n }\n\n protected async getToken(): Promise<string> {\n if (this.token) {\n return this.token;\n }\n\n try {\n return await getVercelOidcToken();\n } catch (err) {\n const cause = err instanceof Error ? err.message : String(err);\n const isDev = process.env.NODE_ENV === 'development';\n\n throw new Error(\n isDev\n ? 'Failed to get OIDC token for local development.\\n\\n' +\n 'To fix this, pull your environment variables with Vercel CLI:\\n' +\n ' `vercel env pull`\\n\\n' +\n `Cause: ${cause}`\n : 'Failed to get OIDC token. This usually means the function is running ' +\n 'outside of a Vercel Function environment.\\n\\n' +\n 'To fix this, either:\\n' +\n ' - Deploy to Vercel (OIDC tokens are provisioned automatically)\\n' +\n ' - Provide a token explicitly: `new Schedules({ token: \"...\" })`\\n\\n' +\n `Cause: ${cause}`,\n );\n }\n }\n\n protected async request<T>(\n method: string,\n path: string,\n body?: unknown,\n ): Promise<T> {\n const headers = new Headers({\n Authorization: `Bearer ${await this.getToken()}`,\n });\n\n if (body !== undefined) {\n headers.set('Content-Type', 'application/json');\n }\n\n const response = await this.fetchImpl(new URL(path, this.baseUrl), {\n method,\n headers,\n body: body === undefined ? undefined : JSON.stringify(body),\n });\n\n if (!response.ok) {\n const text = await response.text();\n throw new SchedulesApiError(response.status, text || response.statusText);\n }\n\n if (response.status === 204) {\n return undefined as T;\n }\n\n return (await response.json()) as T;\n }\n}\n","export const DEFAULT_SCHEDULES_BASE_URL = 'https://vercel-schedules.com';\n","import { SchedulesApiClient } from './api-client';\nimport type {\n CreateScheduleParams,\n CreateScheduleResponse,\n InvokeScheduleParams,\n ListSchedulesParams,\n ListSchedulesResponse,\n Schedule,\n ScheduleIdentifier,\n UpdateScheduleParams,\n UpdateScheduleResponse,\n} from './types';\n\nfunction schedulePath(name: string, namespace?: string, suffix = ''): string {\n const searchParams = new URLSearchParams();\n\n if (namespace !== undefined) {\n searchParams.set('namespace', namespace);\n }\n\n const query = searchParams.toString();\n const path = `/v1/schedules/${encodeURIComponent(name)}${suffix}`;\n\n return query ? `${path}?${query}` : path;\n}\n\nexport class SchedulesClient extends SchedulesApiClient {\n create({\n target,\n ...params\n }: CreateScheduleParams): Promise<CreateScheduleResponse> {\n return this.request('POST', '/v1/schedules', {\n ...params,\n target: {\n type: 'queue',\n topic: target.topic,\n },\n });\n }\n\n list(params: ListSchedulesParams = {}): Promise<ListSchedulesResponse> {\n const searchParams = new URLSearchParams();\n\n if (params.namespace !== undefined) {\n searchParams.set('namespace', params.namespace);\n }\n if (params.cursor !== undefined) {\n searchParams.set('cursor', params.cursor);\n }\n if (params.limit !== undefined) {\n searchParams.set('limit', String(params.limit));\n }\n\n const query = searchParams.toString();\n const path = query ? `/v1/schedules?${query}` : '/v1/schedules';\n\n return this.request('GET', path);\n }\n\n get({ name, namespace }: ScheduleIdentifier): Promise<Schedule> {\n return this.request('GET', schedulePath(name, namespace));\n }\n\n update({\n name,\n namespace,\n target,\n ...params\n }: UpdateScheduleParams): Promise<UpdateScheduleResponse> {\n return this.request('PATCH', schedulePath(name, namespace), {\n ...params,\n ...(target === undefined\n ? {}\n : {\n target: {\n type: 'queue',\n topic: target.topic,\n },\n }),\n });\n }\n\n async delete({ name, namespace }: ScheduleIdentifier): Promise<void> {\n await this.request('DELETE', schedulePath(name, namespace));\n }\n\n enable({ name, namespace }: ScheduleIdentifier): Promise<Schedule> {\n return this.request('POST', schedulePath(name, namespace, '/enable'));\n }\n\n disable({ name, namespace }: ScheduleIdentifier): Promise<Schedule> {\n return this.request('POST', schedulePath(name, namespace, '/disable'));\n }\n\n async invoke({ name, namespace }: InvokeScheduleParams): Promise<void> {\n await this.request('POST', schedulePath(name, namespace, '/invoke'));\n }\n}\n","import { SchedulesClient } from './schedules';\n\nexport const schedules = new SchedulesClient();\n","/** CloudEvent type used for schedule function dispatches. */\nexport const SCHEDULE_CLOUD_EVENT_TYPE = 'com.vercel.schedule.v1beta';\nexport const CLOUD_EVENT_SPEC_VERSION_HEADER = 'ce-specversion';\nexport const CLOUD_EVENT_TYPE_HEADER = 'ce-type';\nexport const CLOUD_EVENT_SOURCE_HEADER = 'ce-source';\nexport const CLOUD_EVENT_ID_HEADER = 'ce-id';\nexport const SCHEDULE_SCHEDULED_AT_HEADER = 'ce-vssscheduledat';\nexport const SCHEDULE_ID_HEADER = 'ce-vssscheduleid';\nexport const SCHEDULE_NAME_HEADER = 'ce-vssschedulename';\nexport const SCHEDULE_NAMESPACE_HEADER = 'ce-vssnamespace';\nexport const SCHEDULE_SOURCE_HEADER = 'ce-vssschedulesource';\n\nexport interface ScheduleMetadata {\n /** Unique identifier of the schedule. */\n scheduleId: string;\n /** Unique identifier for this schedule occurrence. */\n executionId: string;\n /** Schedule name, unique within its project and namespace. */\n name: string;\n /** Namespace the schedule belongs to. */\n namespace: string;\n /**\n * Nominal scheduled time for this occurrence, based on the schedule expression.\n * Does not account for jitter. The dispatch may arrive later within the jitter window.\n */\n scheduledAt: Date;\n /** How the schedule was defined, such as `static`. */\n source: string;\n}\n\nexport type ScheduleHandler = (\n metadata: ScheduleMetadata,\n) => void | Promise<void>;\n\nexport class ScheduleEventParseError extends Error {\n cause?: unknown;\n\n constructor(message: string, options?: { cause?: unknown }) {\n super(message);\n this.name = 'ScheduleEventParseError';\n if (options && 'cause' in options) {\n this.cause = options.cause;\n }\n }\n}\n\nfunction requiredHeader(request: Request, name: string): string {\n const value = request.headers.get(name);\n if (!value) {\n throw new ScheduleEventParseError(\n `Request is missing the ${name} header; it does not look like a schedule dispatch`,\n );\n }\n return value;\n}\n\n/** Parses schedule metadata from a binary-mode schedule CloudEvent. */\nexport async function parseScheduleEvent(\n request: Request,\n): Promise<ScheduleMetadata> {\n if (request.method !== 'POST') {\n throw new ScheduleEventParseError(\n `Schedule dispatches are POST requests, received ${request.method}`,\n );\n }\n\n const specVersion = requiredHeader(request, CLOUD_EVENT_SPEC_VERSION_HEADER);\n if (specVersion !== '1.0') {\n throw new ScheduleEventParseError(\n `Unsupported CloudEvent spec version: ${specVersion}`,\n );\n }\n\n const eventType = requiredHeader(request, CLOUD_EVENT_TYPE_HEADER);\n if (eventType !== SCHEDULE_CLOUD_EVENT_TYPE) {\n throw new ScheduleEventParseError(\n `Unsupported schedule CloudEvent type: ${eventType}`,\n );\n }\n\n requiredHeader(request, CLOUD_EVENT_SOURCE_HEADER);\n const executionId = requiredHeader(request, CLOUD_EVENT_ID_HEADER);\n const scheduledAtValue = requiredHeader(\n request,\n SCHEDULE_SCHEDULED_AT_HEADER,\n );\n const metadata: ScheduleMetadata = {\n scheduleId: requiredHeader(request, SCHEDULE_ID_HEADER),\n executionId,\n name: requiredHeader(request, SCHEDULE_NAME_HEADER),\n namespace: requiredHeader(request, SCHEDULE_NAMESPACE_HEADER),\n scheduledAt: new Date(scheduledAtValue),\n source: requiredHeader(request, SCHEDULE_SOURCE_HEADER),\n };\n\n if (Number.isNaN(metadata.scheduledAt.getTime())) {\n throw new ScheduleEventParseError(\n `Schedule scheduledAt is not a valid timestamp: ${scheduledAtValue}`,\n );\n }\n\n return metadata;\n}\n\n/**\n * Creates a web-standard route handler for schedule dispatches.\n *\n * ```ts\n * export const POST = handleSchedule(async (metadata) => {\n * console.log(metadata.name, metadata.scheduledAt);\n * });\n * ```\n */\nexport function handleSchedule(\n handler: ScheduleHandler,\n): (request: Request) => Promise<Response> {\n return async (request: Request): Promise<Response> => {\n let metadata: ScheduleMetadata;\n try {\n metadata = await parseScheduleEvent(request);\n } catch (error) {\n if (error instanceof ScheduleEventParseError) {\n return Response.json({ error: error.message }, { status: 400 });\n }\n return Response.json(\n { error: 'Failed to parse schedule dispatch' },\n { status: 500 },\n );\n }\n\n try {\n await handler(metadata);\n return new Response(null, { status: 200 });\n } catch {\n return Response.json(\n { error: 'Schedule handler failed' },\n { status: 500 },\n );\n }\n };\n}\n"],"mappings":";AAAA,SAAS,0BAA0B;;;ACA5B,IAAM,6BAA6B;;;ADSnC,IAAM,oBAAN,cAAgC,MAAM;AAAA,EAG3C,YAAY,QAAgB,SAAiB;AAC3C,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,SAAS;AAAA,EAChB;AACF;AAEO,IAAM,qBAAN,MAAyB;AAAA,EAK9B,YAAY,UAAqC,CAAC,GAAG;AAxBvD;AAyBI,SAAK,UAAU,IAAI;AAAA,OACjB,mBAAQ,YAAR,YACE,QAAQ,IAAI,6BADd,YAEE;AAAA,IACJ;AACA,SAAK,QAAQ,QAAQ;AACrB,SAAK,aAAY,aAAQ,UAAR,YAAiB;AAAA,EACpC;AAAA,EAEA,MAAgB,WAA4B;AAC1C,QAAI,KAAK,OAAO;AACd,aAAO,KAAK;AAAA,IACd;AAEA,QAAI;AACF,aAAO,MAAM,mBAAmB;AAAA,IAClC,SAAS,KAAK;AACZ,YAAM,QAAQ,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAC7D,YAAM,QAAQ,QAAQ,IAAI,aAAa;AAEvC,YAAM,IAAI;AAAA,QACR,QACI;AAAA;AAAA;AAAA;AAAA;AAAA,SAGY,KAAK,KACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAKY,KAAK;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAgB,QACd,QACA,MACA,MACY;AACZ,UAAM,UAAU,IAAI,QAAQ;AAAA,MAC1B,eAAe,UAAU,MAAM,KAAK,SAAS,CAAC;AAAA,IAChD,CAAC;AAED,QAAI,SAAS,QAAW;AACtB,cAAQ,IAAI,gBAAgB,kBAAkB;AAAA,IAChD;AAEA,UAAM,WAAW,MAAM,KAAK,UAAU,IAAI,IAAI,MAAM,KAAK,OAAO,GAAG;AAAA,MACjE;AAAA,MACA;AAAA,MACA,MAAM,SAAS,SAAY,SAAY,KAAK,UAAU,IAAI;AAAA,IAC5D,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,OAAO,MAAM,SAAS,KAAK;AACjC,YAAM,IAAI,kBAAkB,SAAS,QAAQ,QAAQ,SAAS,UAAU;AAAA,IAC1E;AAEA,QAAI,SAAS,WAAW,KAAK;AAC3B,aAAO;AAAA,IACT;AAEA,WAAQ,MAAM,SAAS,KAAK;AAAA,EAC9B;AACF;;;AE9EA,SAAS,aAAa,MAAc,WAAoB,SAAS,IAAY;AAC3E,QAAM,eAAe,IAAI,gBAAgB;AAEzC,MAAI,cAAc,QAAW;AAC3B,iBAAa,IAAI,aAAa,SAAS;AAAA,EACzC;AAEA,QAAM,QAAQ,aAAa,SAAS;AACpC,QAAM,OAAO,iBAAiB,mBAAmB,IAAI,CAAC,GAAG,MAAM;AAE/D,SAAO,QAAQ,GAAG,IAAI,IAAI,KAAK,KAAK;AACtC;AAEO,IAAM,kBAAN,cAA8B,mBAAmB;AAAA,EACtD,OAAO;AAAA,IACL;AAAA,IACA,GAAG;AAAA,EACL,GAA0D;AACxD,WAAO,KAAK,QAAQ,QAAQ,iBAAiB;AAAA,MAC3C,GAAG;AAAA,MACH,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,OAAO,OAAO;AAAA,MAChB;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,KAAK,SAA8B,CAAC,GAAmC;AACrE,UAAM,eAAe,IAAI,gBAAgB;AAEzC,QAAI,OAAO,cAAc,QAAW;AAClC,mBAAa,IAAI,aAAa,OAAO,SAAS;AAAA,IAChD;AACA,QAAI,OAAO,WAAW,QAAW;AAC/B,mBAAa,IAAI,UAAU,OAAO,MAAM;AAAA,IAC1C;AACA,QAAI,OAAO,UAAU,QAAW;AAC9B,mBAAa,IAAI,SAAS,OAAO,OAAO,KAAK,CAAC;AAAA,IAChD;AAEA,UAAM,QAAQ,aAAa,SAAS;AACpC,UAAM,OAAO,QAAQ,iBAAiB,KAAK,KAAK;AAEhD,WAAO,KAAK,QAAQ,OAAO,IAAI;AAAA,EACjC;AAAA,EAEA,IAAI,EAAE,MAAM,UAAU,GAA0C;AAC9D,WAAO,KAAK,QAAQ,OAAO,aAAa,MAAM,SAAS,CAAC;AAAA,EAC1D;AAAA,EAEA,OAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EACL,GAA0D;AACxD,WAAO,KAAK,QAAQ,SAAS,aAAa,MAAM,SAAS,GAAG;AAAA,MAC1D,GAAG;AAAA,MACH,GAAI,WAAW,SACX,CAAC,IACD;AAAA,QACE,QAAQ;AAAA,UACN,MAAM;AAAA,UACN,OAAO,OAAO;AAAA,QAChB;AAAA,MACF;AAAA,IACN,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,OAAO,EAAE,MAAM,UAAU,GAAsC;AACnE,UAAM,KAAK,QAAQ,UAAU,aAAa,MAAM,SAAS,CAAC;AAAA,EAC5D;AAAA,EAEA,OAAO,EAAE,MAAM,UAAU,GAA0C;AACjE,WAAO,KAAK,QAAQ,QAAQ,aAAa,MAAM,WAAW,SAAS,CAAC;AAAA,EACtE;AAAA,EAEA,QAAQ,EAAE,MAAM,UAAU,GAA0C;AAClE,WAAO,KAAK,QAAQ,QAAQ,aAAa,MAAM,WAAW,UAAU,CAAC;AAAA,EACvE;AAAA,EAEA,MAAM,OAAO,EAAE,MAAM,UAAU,GAAwC;AACrE,UAAM,KAAK,QAAQ,QAAQ,aAAa,MAAM,WAAW,SAAS,CAAC;AAAA,EACrE;AACF;;;AC/FO,IAAM,YAAY,IAAI,gBAAgB;;;ACDtC,IAAM,4BAA4B;AAClC,IAAM,kCAAkC;AACxC,IAAM,0BAA0B;AAChC,IAAM,4BAA4B;AAClC,IAAM,wBAAwB;AAC9B,IAAM,+BAA+B;AACrC,IAAM,qBAAqB;AAC3B,IAAM,uBAAuB;AAC7B,IAAM,4BAA4B;AAClC,IAAM,yBAAyB;AAwB/B,IAAM,0BAAN,cAAsC,MAAM;AAAA,EAGjD,YAAY,SAAiB,SAA+B;AAC1D,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,QAAI,WAAW,WAAW,SAAS;AACjC,WAAK,QAAQ,QAAQ;AAAA,IACvB;AAAA,EACF;AACF;AAEA,SAAS,eAAe,SAAkB,MAAsB;AAC9D,QAAM,QAAQ,QAAQ,QAAQ,IAAI,IAAI;AACtC,MAAI,CAAC,OAAO;AACV,UAAM,IAAI;AAAA,MACR,0BAA0B,IAAI;AAAA,IAChC;AAAA,EACF;AACA,SAAO;AACT;AAGA,eAAsB,mBACpB,SAC2B;AAC3B,MAAI,QAAQ,WAAW,QAAQ;AAC7B,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,MAAM;AAAA,IACnE;AAAA,EACF;AAEA,QAAM,cAAc,eAAe,SAAS,+BAA+B;AAC3E,MAAI,gBAAgB,OAAO;AACzB,UAAM,IAAI;AAAA,MACR,wCAAwC,WAAW;AAAA,IACrD;AAAA,EACF;AAEA,QAAM,YAAY,eAAe,SAAS,uBAAuB;AACjE,MAAI,cAAc,2BAA2B;AAC3C,UAAM,IAAI;AAAA,MACR,yCAAyC,SAAS;AAAA,IACpD;AAAA,EACF;AAEA,iBAAe,SAAS,yBAAyB;AACjD,QAAM,cAAc,eAAe,SAAS,qBAAqB;AACjE,QAAM,mBAAmB;AAAA,IACvB;AAAA,IACA;AAAA,EACF;AACA,QAAM,WAA6B;AAAA,IACjC,YAAY,eAAe,SAAS,kBAAkB;AAAA,IACtD;AAAA,IACA,MAAM,eAAe,SAAS,oBAAoB;AAAA,IAClD,WAAW,eAAe,SAAS,yBAAyB;AAAA,IAC5D,aAAa,IAAI,KAAK,gBAAgB;AAAA,IACtC,QAAQ,eAAe,SAAS,sBAAsB;AAAA,EACxD;AAEA,MAAI,OAAO,MAAM,SAAS,YAAY,QAAQ,CAAC,GAAG;AAChD,UAAM,IAAI;AAAA,MACR,kDAAkD,gBAAgB;AAAA,IACpE;AAAA,EACF;AAEA,SAAO;AACT;AAWO,SAAS,eACd,SACyC;AACzC,SAAO,OAAO,YAAwC;AACpD,QAAI;AACJ,QAAI;AACF,iBAAW,MAAM,mBAAmB,OAAO;AAAA,IAC7C,SAAS,OAAO;AACd,UAAI,iBAAiB,yBAAyB;AAC5C,eAAO,SAAS,KAAK,EAAE,OAAO,MAAM,QAAQ,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,MAChE;AACA,aAAO,SAAS;AAAA,QACd,EAAE,OAAO,oCAAoC;AAAA,QAC7C,EAAE,QAAQ,IAAI;AAAA,MAChB;AAAA,IACF;AAEA,QAAI;AACF,YAAM,QAAQ,QAAQ;AACtB,aAAO,IAAI,SAAS,MAAM,EAAE,QAAQ,IAAI,CAAC;AAAA,IAC3C,QAAQ;AACN,aAAO,SAAS;AAAA,QACd,EAAE,OAAO,0BAA0B;AAAA,QACnC,EAAE,QAAQ,IAAI;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AACF;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vercel/schedules",
|
|
3
|
-
"version": "0.0.0-alpha.
|
|
3
|
+
"version": "0.0.0-alpha.10",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -36,6 +36,9 @@
|
|
|
36
36
|
"tsup": "8.5.1",
|
|
37
37
|
"tsconfig": "0.0.0"
|
|
38
38
|
},
|
|
39
|
+
"dependencies": {
|
|
40
|
+
"@vercel/oidc": "^3.0.5"
|
|
41
|
+
},
|
|
39
42
|
"engines": {
|
|
40
43
|
"node": ">=20.0.0"
|
|
41
44
|
},
|