@aeriajs/builtins 0.0.10 → 0.0.13

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

@@ -115,6 +115,69 @@ export declare const tempFile: Omit<import("@aeriajs/types").Collection<{
             };
         }>, ...args: any[]) => any;
     };
+    functionContracts: Partial<{
+        [x: string]: import("@aeriajs/types").Contract;
+    }>;
+    accessControl: import("@aeriajs/types").AccessControl<{
+        description: {
+            readonly $id: "tempFile";
+            readonly temporary: {
+                readonly index: "created_at";
+                readonly expireAfterSeconds: 3600;
+            };
+            readonly properties: {
+                readonly created_at: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly absolute_path: {
+                    readonly type: "string";
+                };
+                readonly size: {
+                    readonly type: "number";
+                };
+                readonly mime: {
+                    readonly type: "number";
+                };
+                readonly collection: {
+                    readonly type: "string";
+                };
+                readonly filename: {
+                    readonly type: "string";
+                };
+            };
+        };
+        functions: {
+            [P: string]: (payload: any, context: import("@aeriajs/types").Context<{
+                readonly $id: "tempFile";
+                readonly temporary: {
+                    readonly index: "created_at";
+                    readonly expireAfterSeconds: 3600;
+                };
+                readonly properties: {
+                    readonly created_at: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly mime: {
+                        readonly type: "number";
+                    };
+                    readonly collection: {
+                        readonly type: "string";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                };
+            }>, ...args: any[]) => any;
+        };
+    }>;
 };
 export declare const file: Omit<import("@aeriajs/types").Collection<{
     description: {
@@ -1180,4 +1243,519 @@ export declare const file: Omit<import("@aeriajs/types").Collection<{
             };
         }>) => Promise<any>;
     };
+    functionContracts: Partial<{
+        readonly get: import("@aeriajs/types").Contract;
+        readonly insert: import("@aeriajs/types").Contract;
+        readonly download: import("@aeriajs/types").Contract;
+        readonly remove: import("@aeriajs/types").Contract;
+        readonly removeAll: import("@aeriajs/types").Contract;
+    }>;
+    accessControl: import("@aeriajs/types").AccessControl<{
+        description: {
+            readonly $id: "file";
+            readonly owned: "always";
+            readonly presets: readonly ["owned"];
+            readonly indexes: readonly ["filename", "link", "mime"];
+            readonly properties: {
+                readonly mime: {
+                    readonly type: "string";
+                };
+                readonly size: {
+                    readonly type: "number";
+                };
+                readonly last_modified: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly filename: {
+                    readonly type: "string";
+                };
+                readonly absolute_path: {
+                    readonly type: "string";
+                };
+                readonly relative_path: {
+                    readonly type: "string";
+                };
+                readonly immutable: {
+                    readonly type: "boolean";
+                };
+                readonly link: {
+                    readonly getter: (value: any) => Promise<string>;
+                };
+                readonly download_link: {
+                    readonly getter: (value: any) => Promise<string>;
+                };
+            };
+            readonly actions: {
+                readonly deleteAll: {
+                    readonly name: "Remover";
+                    readonly ask: true;
+                    readonly selection: true;
+                };
+            };
+            readonly individualActions: {
+                readonly remove: {
+                    readonly name: "Remover";
+                    readonly icon: "trash";
+                    readonly ask: true;
+                };
+            };
+        };
+        functions: {
+            readonly get: (payload: import("@aeriajs/types").GetPayload<import("@aeriajs/types").SchemaWithId<{
+                readonly $id: "file";
+                readonly owned: "always";
+                readonly presets: readonly ["owned"];
+                readonly indexes: readonly ["filename", "link", "mime"];
+                readonly properties: {
+                    readonly mime: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly last_modified: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly relative_path: {
+                        readonly type: "string";
+                    };
+                    readonly immutable: {
+                        readonly type: "boolean";
+                    };
+                    readonly link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                    readonly download_link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                };
+                readonly actions: {
+                    readonly deleteAll: {
+                        readonly name: "Remover";
+                        readonly ask: true;
+                        readonly selection: true;
+                    };
+                };
+                readonly individualActions: {
+                    readonly remove: {
+                        readonly name: "Remover";
+                        readonly icon: "trash";
+                        readonly ask: true;
+                    };
+                };
+            }>>, context: import("@aeriajs/types").Context<{
+                readonly $id: "file";
+                readonly owned: "always";
+                readonly presets: readonly ["owned"];
+                readonly indexes: readonly ["filename", "link", "mime"];
+                readonly properties: {
+                    readonly mime: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly last_modified: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly relative_path: {
+                        readonly type: "string";
+                    };
+                    readonly immutable: {
+                        readonly type: "boolean";
+                    };
+                    readonly link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                    readonly download_link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                };
+                readonly actions: {
+                    readonly deleteAll: {
+                        readonly name: "Remover";
+                        readonly ask: true;
+                        readonly selection: true;
+                    };
+                };
+                readonly individualActions: {
+                    readonly remove: {
+                        readonly name: "Remover";
+                        readonly icon: "trash";
+                        readonly ask: true;
+                    };
+                };
+            }>, options?: import("@aeriajs/api").GetOptions | undefined) => Promise<import("@aeriajs/types").SchemaWithId<{
+                readonly $id: "file";
+                readonly owned: "always";
+                readonly presets: readonly ["owned"];
+                readonly indexes: readonly ["filename", "link", "mime"];
+                readonly properties: {
+                    readonly mime: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly last_modified: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly relative_path: {
+                        readonly type: "string";
+                    };
+                    readonly immutable: {
+                        readonly type: "boolean";
+                    };
+                    readonly link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                    readonly download_link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                };
+                readonly actions: {
+                    readonly deleteAll: {
+                        readonly name: "Remover";
+                        readonly ask: true;
+                        readonly selection: true;
+                    };
+                };
+                readonly individualActions: {
+                    readonly remove: {
+                        readonly name: "Remover";
+                        readonly icon: "trash";
+                        readonly ask: true;
+                    };
+                };
+            }> | null>;
+            readonly insert: (payload: {
+                what: {
+                    content: string;
+                } & Pick<import("@aeriajs/types").PackReferences<import("@aeriajs/types").SchemaWithId<{
+                    readonly $id: "file";
+                    readonly owned: "always";
+                    readonly presets: readonly ["owned"];
+                    readonly indexes: readonly ["filename", "link", "mime"];
+                    readonly properties: {
+                        readonly mime: {
+                            readonly type: "string";
+                        };
+                        readonly size: {
+                            readonly type: "number";
+                        };
+                        readonly last_modified: {
+                            readonly type: "string";
+                            readonly format: "date-time";
+                        };
+                        readonly filename: {
+                            readonly type: "string";
+                        };
+                        readonly absolute_path: {
+                            readonly type: "string";
+                        };
+                        readonly relative_path: {
+                            readonly type: "string";
+                        };
+                        readonly immutable: {
+                            readonly type: "boolean";
+                        };
+                        readonly link: {
+                            readonly getter: (value: any) => Promise<string>;
+                        };
+                        readonly download_link: {
+                            readonly getter: (value: any) => Promise<string>;
+                        };
+                    };
+                    readonly actions: {
+                        readonly deleteAll: {
+                            readonly name: "Remover";
+                            readonly ask: true;
+                            readonly selection: true;
+                        };
+                    };
+                    readonly individualActions: {
+                        readonly remove: {
+                            readonly name: "Remover";
+                            readonly icon: "trash";
+                            readonly ask: true;
+                        };
+                    };
+                }>>, "filename" | "absolute_path" | "_id" | "owner">;
+            }, context: import("@aeriajs/types").Context<{
+                readonly $id: "file";
+                readonly owned: "always";
+                readonly presets: readonly ["owned"];
+                readonly indexes: readonly ["filename", "link", "mime"];
+                readonly properties: {
+                    readonly mime: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly last_modified: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly relative_path: {
+                        readonly type: "string";
+                    };
+                    readonly immutable: {
+                        readonly type: "boolean";
+                    };
+                    readonly link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                    readonly download_link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                };
+                readonly actions: {
+                    readonly deleteAll: {
+                        readonly name: "Remover";
+                        readonly ask: true;
+                        readonly selection: true;
+                    };
+                };
+                readonly individualActions: {
+                    readonly remove: {
+                        readonly name: "Remover";
+                        readonly icon: "trash";
+                        readonly ask: true;
+                    };
+                };
+            }>) => Promise<import("@aeriajs/types").Right<any> | import("@aeriajs/types").Left<import("@aeriajs/types").ACErrors | import("@aeriajs/types").ValidationError>>;
+            readonly download: (payload: {
+                fileId: string;
+                options: readonly ("download" | "picture")[];
+                noHeaders?: boolean | undefined;
+            }, context: import("@aeriajs/types").Context<{
+                readonly $id: "file";
+                readonly owned: "always";
+                readonly presets: readonly ["owned"];
+                readonly indexes: readonly ["filename", "link", "mime"];
+                readonly properties: {
+                    readonly mime: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly last_modified: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly relative_path: {
+                        readonly type: "string";
+                    };
+                    readonly immutable: {
+                        readonly type: "boolean";
+                    };
+                    readonly link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                    readonly download_link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                };
+                readonly actions: {
+                    readonly deleteAll: {
+                        readonly name: "Remover";
+                        readonly ask: true;
+                        readonly selection: true;
+                    };
+                };
+                readonly individualActions: {
+                    readonly remove: {
+                        readonly name: "Remover";
+                        readonly icon: "trash";
+                        readonly ask: true;
+                    };
+                };
+            }>) => Promise<import("@aeriajs/types").Left<import("./download.js").FileReadError.DocumentNotFound> | import("@aeriajs/types").Left<import("./download.js").FileReadError.FileNotFound> | import("fs").ReadStream>;
+            readonly remove: (payload: import("@aeriajs/types").RemovePayload<import("@aeriajs/types").SchemaWithId<{
+                readonly $id: "file";
+                readonly owned: "always";
+                readonly presets: readonly ["owned"];
+                readonly indexes: readonly ["filename", "link", "mime"];
+                readonly properties: {
+                    readonly mime: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly last_modified: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly relative_path: {
+                        readonly type: "string";
+                    };
+                    readonly immutable: {
+                        readonly type: "boolean";
+                    };
+                    readonly link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                    readonly download_link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                };
+                readonly actions: {
+                    readonly deleteAll: {
+                        readonly name: "Remover";
+                        readonly ask: true;
+                        readonly selection: true;
+                    };
+                };
+                readonly individualActions: {
+                    readonly remove: {
+                        readonly name: "Remover";
+                        readonly icon: "trash";
+                        readonly ask: true;
+                    };
+                };
+            }>>, context: import("@aeriajs/types").Context<{
+                readonly $id: "file";
+                readonly owned: "always";
+                readonly presets: readonly ["owned"];
+                readonly indexes: readonly ["filename", "link", "mime"];
+                readonly properties: {
+                    readonly mime: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly last_modified: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly relative_path: {
+                        readonly type: "string";
+                    };
+                    readonly immutable: {
+                        readonly type: "boolean";
+                    };
+                    readonly link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                    readonly download_link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                };
+                readonly actions: {
+                    readonly deleteAll: {
+                        readonly name: "Remover";
+                        readonly ask: true;
+                        readonly selection: true;
+                    };
+                };
+                readonly individualActions: {
+                    readonly remove: {
+                        readonly name: "Remover";
+                        readonly icon: "trash";
+                        readonly ask: true;
+                    };
+                };
+            }>) => Promise<any>;
+            readonly removeAll: (payload: import("@aeriajs/types").RemoveAllPayload, context: import("@aeriajs/types").Context<{
+                readonly $id: "file";
+                readonly owned: "always";
+                readonly presets: readonly ["owned"];
+                readonly indexes: readonly ["filename", "link", "mime"];
+                readonly properties: {
+                    readonly mime: {
+                        readonly type: "string";
+                    };
+                    readonly size: {
+                        readonly type: "number";
+                    };
+                    readonly last_modified: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filename: {
+                        readonly type: "string";
+                    };
+                    readonly absolute_path: {
+                        readonly type: "string";
+                    };
+                    readonly relative_path: {
+                        readonly type: "string";
+                    };
+                    readonly immutable: {
+                        readonly type: "boolean";
+                    };
+                    readonly link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                    readonly download_link: {
+                        readonly getter: (value: any) => Promise<string>;
+                    };
+                };
+                readonly actions: {
+                    readonly deleteAll: {
+                        readonly name: "Remover";
+                        readonly ask: true;
+                        readonly selection: true;
+                    };
+                };
+                readonly individualActions: {
+                    readonly remove: {
+                        readonly name: "Remover";
+                        readonly icon: "trash";
+                        readonly ask: true;
+                    };
+                };
+            }>) => Promise<any>;
+        };
+    }>;
 };