@aurabase/functions 0.6.0 → 0.6.2

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/dist/index.cjs CHANGED
@@ -265,6 +265,10 @@ var FunctionsService = class extends core.BaseService {
265
265
  }
266
266
  }
267
267
  // -- Function CRUD ----------------------------------------------------------
268
+ /**
269
+ * Liste les fonctions déployées du projet, avec leur code source et leurs variables.
270
+ * Exige une clé `service_role` : une clé publique reçoit `403`.
271
+ */
268
272
  async list() {
269
273
  return this.request("GET", `${this.prefix}`);
270
274
  }
@@ -279,6 +283,10 @@ var FunctionsService = class extends core.BaseService {
279
283
  return this.request("GET", `${this.prefix}/${seg(nameOrId)}`);
280
284
  }
281
285
  // -- Jobs -------------------------------------------------------------------
286
+ /**
287
+ * Liste les jobs asynchrones du projet, filtrés par `status` (`pending`, `running`, `completed`,
288
+ * `failed`, `dead`). `limit` va de 1 à 500 (50 par défaut). Exige une clé `service_role`.
289
+ */
282
290
  async listJobs(options) {
283
291
  const params = new URLSearchParams();
284
292
  if (options?.status) params.set("status", options.status);
@@ -286,6 +294,7 @@ var FunctionsService = class extends core.BaseService {
286
294
  const qs = params.toString() ? `?${params.toString()}` : "";
287
295
  return this.request("GET", `${this.prefix}/jobs${qs}`);
288
296
  }
297
+ /** Lit un job par son identifiant. Exige une clé `service_role`. */
289
298
  async getJob(jobId) {
290
299
  return this.request("GET", `${this.prefix}/jobs/${seg(jobId)}`);
291
300
  }
@@ -313,9 +322,15 @@ var FunctionsService = class extends core.BaseService {
313
322
  });
314
323
  }
315
324
  // -- Cron -------------------------------------------------------------------
325
+ /** Liste les tâches cron du projet. Exige une clé `service_role`. */
316
326
  async listCronJobs() {
317
327
  return this.request("GET", `${this.prefix}/cron`);
318
328
  }
329
+ /**
330
+ * Crée une tâche cron : à chaque échéance, un job est mis en file pour `functionName`.
331
+ * `schedule` compte 5 champs (`min heure jour mois jour-semaine`) ou 6 (avec les secondes), en UTC ;
332
+ * les alias comme `@daily` sont refusés. Le `payload` est figé à la création. Exige une clé `service_role`.
333
+ */
319
334
  async createCronJob(name, schedule, functionName, options) {
320
335
  return this.request("POST", `${this.prefix}/cron`, {
321
336
  name,
@@ -324,6 +339,10 @@ var FunctionsService = class extends core.BaseService {
324
339
  payload: options?.payload
325
340
  });
326
341
  }
342
+ /**
343
+ * Supprime une tâche cron par son NOM (et non son identifiant) ; un nom inconnu renvoie 404.
344
+ * La tâche cesse aussi de se déclencher. Exige une clé `service_role`.
345
+ */
327
346
  async deleteCronJob(name) {
328
347
  return this.request("DELETE", `${this.prefix}/cron/${seg(name)}`);
329
348
  }
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { AuraError, BaseService, AuraClientLike, AuraResponse, FunctionDef, Job, CronJob } from '@aurabase/core';
2
- export { AuraResponse, CronJob, FunctionDef, Job } from '@aurabase/core';
2
+ export { AuraResponse, CronJob, FunctionDef, FunctionPermissions, Job } from '@aurabase/core';
3
3
 
4
4
  declare function isRelayStatus(status: number): boolean;
5
5
  /**
@@ -84,6 +84,10 @@ declare class FunctionsService extends BaseService {
84
84
  timeout?: number;
85
85
  responseType?: FunctionsResponseType;
86
86
  }): Promise<AuraResponse<T>>;
87
+ /**
88
+ * Liste les fonctions déployées du projet, avec leur code source et leurs variables.
89
+ * Exige une clé `service_role` : une clé publique reçoit `403`.
90
+ */
87
91
  list(): Promise<AuraResponse<FunctionDef[]>>;
88
92
  /**
89
93
  * Lit une fonction par son **nom** ou par son **identifiant** (B10).
@@ -93,10 +97,15 @@ declare class FunctionsService extends BaseService {
93
97
  * le NOM l'emporte. Une valeur qui n'est ni l'un ni l'autre produit un 404 qui le dit.
94
98
  */
95
99
  get(nameOrId: string): Promise<AuraResponse<FunctionDef>>;
100
+ /**
101
+ * Liste les jobs asynchrones du projet, filtrés par `status` (`pending`, `running`, `completed`,
102
+ * `failed`, `dead`). `limit` va de 1 à 500 (50 par défaut). Exige une clé `service_role`.
103
+ */
96
104
  listJobs(options?: {
97
105
  status?: string;
98
106
  limit?: number;
99
107
  }): Promise<AuraResponse<Job[]>>;
108
+ /** Lit un job par son identifiant. Exige une clé `service_role`. */
100
109
  getJob(jobId: string): Promise<AuraResponse<Job>>;
101
110
  /**
102
111
  * Enfile un job d'exécution asynchrone en arrière-plan pour une fonction.
@@ -110,10 +119,20 @@ declare class FunctionsService extends BaseService {
110
119
  delaySecs?: number;
111
120
  maxAttempts?: number;
112
121
  }): Promise<AuraResponse<Job>>;
122
+ /** Liste les tâches cron du projet. Exige une clé `service_role`. */
113
123
  listCronJobs(): Promise<AuraResponse<CronJob[]>>;
124
+ /**
125
+ * Crée une tâche cron : à chaque échéance, un job est mis en file pour `functionName`.
126
+ * `schedule` compte 5 champs (`min heure jour mois jour-semaine`) ou 6 (avec les secondes), en UTC ;
127
+ * les alias comme `@daily` sont refusés. Le `payload` est figé à la création. Exige une clé `service_role`.
128
+ */
114
129
  createCronJob(name: string, schedule: string, functionName: string, options?: {
115
130
  payload?: unknown;
116
131
  }): Promise<AuraResponse<CronJob>>;
132
+ /**
133
+ * Supprime une tâche cron par son NOM (et non son identifiant) ; un nom inconnu renvoie 404.
134
+ * La tâche cesse aussi de se déclencher. Exige une clé `service_role`.
135
+ */
117
136
  deleteCronJob(name: string): Promise<AuraResponse<null>>;
118
137
  }
119
138
 
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { AuraError, BaseService, AuraClientLike, AuraResponse, FunctionDef, Job, CronJob } from '@aurabase/core';
2
- export { AuraResponse, CronJob, FunctionDef, Job } from '@aurabase/core';
2
+ export { AuraResponse, CronJob, FunctionDef, FunctionPermissions, Job } from '@aurabase/core';
3
3
 
4
4
  declare function isRelayStatus(status: number): boolean;
5
5
  /**
@@ -84,6 +84,10 @@ declare class FunctionsService extends BaseService {
84
84
  timeout?: number;
85
85
  responseType?: FunctionsResponseType;
86
86
  }): Promise<AuraResponse<T>>;
87
+ /**
88
+ * Liste les fonctions déployées du projet, avec leur code source et leurs variables.
89
+ * Exige une clé `service_role` : une clé publique reçoit `403`.
90
+ */
87
91
  list(): Promise<AuraResponse<FunctionDef[]>>;
88
92
  /**
89
93
  * Lit une fonction par son **nom** ou par son **identifiant** (B10).
@@ -93,10 +97,15 @@ declare class FunctionsService extends BaseService {
93
97
  * le NOM l'emporte. Une valeur qui n'est ni l'un ni l'autre produit un 404 qui le dit.
94
98
  */
95
99
  get(nameOrId: string): Promise<AuraResponse<FunctionDef>>;
100
+ /**
101
+ * Liste les jobs asynchrones du projet, filtrés par `status` (`pending`, `running`, `completed`,
102
+ * `failed`, `dead`). `limit` va de 1 à 500 (50 par défaut). Exige une clé `service_role`.
103
+ */
96
104
  listJobs(options?: {
97
105
  status?: string;
98
106
  limit?: number;
99
107
  }): Promise<AuraResponse<Job[]>>;
108
+ /** Lit un job par son identifiant. Exige une clé `service_role`. */
100
109
  getJob(jobId: string): Promise<AuraResponse<Job>>;
101
110
  /**
102
111
  * Enfile un job d'exécution asynchrone en arrière-plan pour une fonction.
@@ -110,10 +119,20 @@ declare class FunctionsService extends BaseService {
110
119
  delaySecs?: number;
111
120
  maxAttempts?: number;
112
121
  }): Promise<AuraResponse<Job>>;
122
+ /** Liste les tâches cron du projet. Exige une clé `service_role`. */
113
123
  listCronJobs(): Promise<AuraResponse<CronJob[]>>;
124
+ /**
125
+ * Crée une tâche cron : à chaque échéance, un job est mis en file pour `functionName`.
126
+ * `schedule` compte 5 champs (`min heure jour mois jour-semaine`) ou 6 (avec les secondes), en UTC ;
127
+ * les alias comme `@daily` sont refusés. Le `payload` est figé à la création. Exige une clé `service_role`.
128
+ */
114
129
  createCronJob(name: string, schedule: string, functionName: string, options?: {
115
130
  payload?: unknown;
116
131
  }): Promise<AuraResponse<CronJob>>;
132
+ /**
133
+ * Supprime une tâche cron par son NOM (et non son identifiant) ; un nom inconnu renvoie 404.
134
+ * La tâche cesse aussi de se déclencher. Exige une clé `service_role`.
135
+ */
117
136
  deleteCronJob(name: string): Promise<AuraResponse<null>>;
118
137
  }
119
138
 
package/dist/index.js CHANGED
@@ -263,6 +263,10 @@ var FunctionsService = class extends BaseService {
263
263
  }
264
264
  }
265
265
  // -- Function CRUD ----------------------------------------------------------
266
+ /**
267
+ * Liste les fonctions déployées du projet, avec leur code source et leurs variables.
268
+ * Exige une clé `service_role` : une clé publique reçoit `403`.
269
+ */
266
270
  async list() {
267
271
  return this.request("GET", `${this.prefix}`);
268
272
  }
@@ -277,6 +281,10 @@ var FunctionsService = class extends BaseService {
277
281
  return this.request("GET", `${this.prefix}/${seg(nameOrId)}`);
278
282
  }
279
283
  // -- Jobs -------------------------------------------------------------------
284
+ /**
285
+ * Liste les jobs asynchrones du projet, filtrés par `status` (`pending`, `running`, `completed`,
286
+ * `failed`, `dead`). `limit` va de 1 à 500 (50 par défaut). Exige une clé `service_role`.
287
+ */
280
288
  async listJobs(options) {
281
289
  const params = new URLSearchParams();
282
290
  if (options?.status) params.set("status", options.status);
@@ -284,6 +292,7 @@ var FunctionsService = class extends BaseService {
284
292
  const qs = params.toString() ? `?${params.toString()}` : "";
285
293
  return this.request("GET", `${this.prefix}/jobs${qs}`);
286
294
  }
295
+ /** Lit un job par son identifiant. Exige une clé `service_role`. */
287
296
  async getJob(jobId) {
288
297
  return this.request("GET", `${this.prefix}/jobs/${seg(jobId)}`);
289
298
  }
@@ -311,9 +320,15 @@ var FunctionsService = class extends BaseService {
311
320
  });
312
321
  }
313
322
  // -- Cron -------------------------------------------------------------------
323
+ /** Liste les tâches cron du projet. Exige une clé `service_role`. */
314
324
  async listCronJobs() {
315
325
  return this.request("GET", `${this.prefix}/cron`);
316
326
  }
327
+ /**
328
+ * Crée une tâche cron : à chaque échéance, un job est mis en file pour `functionName`.
329
+ * `schedule` compte 5 champs (`min heure jour mois jour-semaine`) ou 6 (avec les secondes), en UTC ;
330
+ * les alias comme `@daily` sont refusés. Le `payload` est figé à la création. Exige une clé `service_role`.
331
+ */
317
332
  async createCronJob(name, schedule, functionName, options) {
318
333
  return this.request("POST", `${this.prefix}/cron`, {
319
334
  name,
@@ -322,6 +337,10 @@ var FunctionsService = class extends BaseService {
322
337
  payload: options?.payload
323
338
  });
324
339
  }
340
+ /**
341
+ * Supprime une tâche cron par son NOM (et non son identifiant) ; un nom inconnu renvoie 404.
342
+ * La tâche cesse aussi de se déclencher. Exige une clé `service_role`.
343
+ */
325
344
  async deleteCronJob(name) {
326
345
  return this.request("DELETE", `${this.prefix}/cron/${seg(name)}`);
327
346
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aurabase/functions",
3
- "version": "0.6.0",
3
+ "version": "0.6.2",
4
4
  "description": "Service edge functions du SDK Aurabase (invoke, jobs asynchrones, cron)",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",
@@ -31,12 +31,12 @@
31
31
  "author": "Aurabase",
32
32
  "repository": {
33
33
  "type": "git",
34
- "url": "git+https://github.com/daylami555/aurabase.git",
34
+ "url": "git+https://github.com/Aurabase-cloud/Aurabase.git",
35
35
  "directory": "aurabase-js/packages/functions"
36
36
  },
37
37
  "homepage": "https://aurabase.cloud",
38
38
  "bugs": {
39
- "url": "https://github.com/daylami555/aurabase/issues"
39
+ "url": "https://github.com/Aurabase-cloud/Aurabase/issues"
40
40
  },
41
41
  "keywords": [
42
42
  "aurabase",
@@ -45,7 +45,7 @@
45
45
  "functions"
46
46
  ],
47
47
  "dependencies": {
48
- "@aurabase/core": "0.6.0"
48
+ "@aurabase/core": "0.6.2"
49
49
  },
50
50
  "devDependencies": {
51
51
  "@types/node": "20.14.15",