@aeriajs/builtins 0.0.256 → 0.0.258

package/dist/collections/file/download.d.ts

@@ -1,19 +1,59 @@
-import type { Context } from '@aeriajs/types';
-import type { description } from './description.js';
-import * as fs from 'node:fs';
+import type { Context, ContractToFunction } from '@aeriajs/types';
+import { type description } from './description.js';
 export declare const DownloadError: {
     readonly RangeNotSatisfiable: "RANGE_NOT_SATISFIABLE";
 };
-export declare const download: (payload: {
-    fileId: string;
-    options: readonly ("picture" | "download")[];
-    noHeaders?: boolean;
-}, context: Context<typeof description>) => Promise<import("@aeriajs/types").Result.Error<{
-    readonly code: "RESOURCE_NOT_FOUND";
-} & {
-    httpStatus: 404;
-}> | import("@aeriajs/types").Result.Error<{
-    readonly code: "RANGE_NOT_SATISFIABLE";
-} & {
-    httpStatus: 416;
-}> | fs.ReadStream>;
+export declare const downloadContract: {
+    readonly payload: {
+        readonly type: "object";
+        readonly required: readonly ["fileId"];
+        readonly properties: {
+            readonly fileId: {
+                readonly type: "string";
+            };
+            readonly options: {
+                readonly type: "array";
+                readonly items: {
+                    readonly enum: readonly ["picture", "download"];
+                };
+            };
+            readonly noHeaders: {
+                readonly type: "boolean";
+            };
+        };
+    };
+    readonly response: [{
+        readonly type: "object";
+        readonly properties: {
+            readonly _tag: {
+                readonly const: "Error";
+            };
+            readonly result: {
+                readonly const: undefined;
+            };
+            readonly error: {
+                readonly type: "object";
+                readonly required: readonly ["httpStatus", "code"];
+                readonly properties: {
+                    readonly httpStatus: {
+                        readonly enum: [404, 416];
+                    };
+                    readonly code: {
+                        readonly enum: ["RESOURCE_NOT_FOUND", "RANGE_NOT_SATISFIABLE"];
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                    };
+                    readonly details: {
+                        readonly type: "object";
+                        readonly additionalProperties: true;
+                    };
+                };
+            };
+        };
+    }, {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    }];
+};
+export declare const download: ContractToFunction<typeof downloadContract, Context<typeof description>>;

package/dist/collections/file/download.js

@@ -1,12 +1,51 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.download = exports.DownloadError = void 0;
+exports.download = exports.downloadContract = exports.DownloadError = void 0;
 const types_1 = require("@aeriajs/types");
 const core_1 = require("@aeriajs/core");
 const fs = require("node:fs");
 exports.DownloadError = {
     RangeNotSatisfiable: 'RANGE_NOT_SATISFIABLE',
 };
+exports.downloadContract = (0, types_1.defineContract)({
+    payload: {
+        type: 'object',
+        required: ['fileId'],
+        properties: {
+            fileId: {
+                type: 'string',
+            },
+            options: {
+                type: 'array',
+                items: {
+                    enum: [
+                        'picture',
+                        'download',
+                    ],
+                },
+            },
+            noHeaders: {
+                type: 'boolean',
+            },
+        },
+    },
+    response: [
+        (0, types_1.endpointErrorSchema)({
+            httpStatus: [
+                types_1.HTTPStatus.NotFound,
+                types_1.HTTPStatus.RangeNotSatisfiable,
+            ],
+            code: [
+                types_1.ACError.ResourceNotFound,
+                exports.DownloadError.RangeNotSatisfiable,
+            ],
+        }),
+        {
+            type: 'object',
+            additionalProperties: true,
+        },
+    ],
+});
 const download = async (payload, context) => {
     const { fileId, options = [] } = payload;
     const file = await context.collection.model.findOne({

package/dist/collections/file/download.mjs

@@ -1,10 +1,49 @@
 "use strict";
-import { HTTPStatus, ACError } from "@aeriajs/types";
+import { HTTPStatus, ACError, defineContract, endpointErrorSchema } from "@aeriajs/types";
 import { ObjectId } from "@aeriajs/core";
 import * as fs from "node:fs";
 export const DownloadError = {
   RangeNotSatisfiable: "RANGE_NOT_SATISFIABLE"
 };
+export const downloadContract = defineContract({
+  payload: {
+    type: "object",
+    required: ["fileId"],
+    properties: {
+      fileId: {
+        type: "string"
+      },
+      options: {
+        type: "array",
+        items: {
+          enum: [
+            "picture",
+            "download"
+          ]
+        }
+      },
+      noHeaders: {
+        type: "boolean"
+      }
+    }
+  },
+  response: [
+    endpointErrorSchema({
+      httpStatus: [
+        HTTPStatus.NotFound,
+        HTTPStatus.RangeNotSatisfiable
+      ],
+      code: [
+        ACError.ResourceNotFound,
+        DownloadError.RangeNotSatisfiable
+      ]
+    }),
+    {
+      type: "object",
+      additionalProperties: true
+    }
+  ]
+});
 export const download = async (payload, context) => {
   const { fileId, options = [] } = payload;
   const file = await context.collection.model.findOne({