@webda/fs 4.0.0-beta.3

package/LICENSE

@@ -0,0 +1,166 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

package/README.md

@@ -0,0 +1,130 @@
+# @webda/fs module
+
+This module is part of Webda Application Framework that allows you to quickly develop applications with all modern prerequisites: Security, Extensibility, GraphQL, REST, CloudNative [https://webda.io](https://webda.io)
+
+<img src="https://webda.io/images/webda.svg" width="128" />
+
+![CI](https://github.com/loopingz/webda.io/workflows/CI/badge.svg)
+
+[![Join the chat at https://gitter.im/loopingz/webda](https://badges.gitter.im/loopingz/webda.svg)](https://gitter.im/loopingz/webda?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![codecov](https://codecov.io/gh/loopingz/webda.io/branch/main/graph/badge.svg?token=8N9DNM3K3O)](https://codecov.io/gh/loopingz/webda.io)
+[![SonarCloud.io](https://sonarcloud.io/api/project_badges/measure?project=loopingz_webda.io&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=loopingz_webda.io)
+![CodeQL](https://github.com/loopingz/webda.io/workflows/CodeQL/badge.svg)
+
+<!-- README_HEADER -->
+
+# @webda/fs
+
+> Filesystem-backed Store, Binary, and Queue implementations for Webda — ideal for local development, testing, or single-instance deployments where you want persistence without an external database.
+
+## When to use it
+
+- You are developing or running unit tests locally and need a zero-config persistent store without spinning up a database.
+- You need to store file uploads on local disk (e.g. a blog system or a small self-hosted app) using `FileBinary`.
+- You want a file-backed queue (`FileQueue`) for sequential task processing in a single-process scenario.
+
+## Install
+
+```bash
+pnpm add @webda/fs
+```
+
+## Configuration
+
+```json
+{
+  "services": {
+    "postStore": {
+      "type": "FileStore",
+      "model": "MyApp/Post",
+      "folder": "./data/posts"
+    },
+    "uploads": {
+      "type": "FileBinary",
+      "folder": "./data/uploads",
+      "maxSize": 10485760
+    },
+    "fileQueue": {
+      "type": "FileQueue",
+      "folder": "./data/queue"
+    }
+  }
+}
+```
+
+### FileStore parameters
+
+| Parameter | Type | Default | Required | Description |
+|---|---|---|---|---|
+| `folder` | string | — | Yes | Directory where each model instance is stored as a JSON file |
+| `beautify` | string \| number | — | No | Indentation passed to `JSON.stringify` (e.g. `2` for pretty-print) |
+
+### FileBinary parameters
+
+| Parameter | Type | Default | Required | Description |
+|---|---|---|---|---|
+| `folder` | string | — | Yes | Directory where uploaded binaries are stored |
+| `maxSize` | number | `10485760` | No | Maximum accepted upload size in bytes (default 10 MB) |
+| `url` | string | — | No | URL prefix for direct-download links |
+
+## Usage
+
+```typescript
+import { CoreModel, Model, Expose, BinaryFile, BinaryMap } from "@webda/core";
+import { Bean, Inject } from "@webda/core";
+import { Store } from "@webda/core";
+
+@Model()
+export class Post extends CoreModel {
+  @Expose()
+  title: string;
+
+  @BinaryMap({ cardinality: "ONE" })
+  cover: BinaryFile;
+}
+
+// In webda.config.json: configure FileStore (model storage) and FileBinary (uploads)
+// Webda auto-wires them — no extra service code required.
+
+// Programmatic usage
+@Bean
+export class PostService extends Service {
+  @Inject("postStore")
+  store: Store<Post>;
+
+  async createPost(title: string): Promise<Post> {
+    const post = new Post();
+    post.title = title;
+    return post.save();
+  }
+
+  async listPosts(): Promise<Post[]> {
+    return (await Post.query("")).results;
+  }
+}
+```
+
+## Reference
+
+- API reference: see the auto-generated typedoc at `docs/pages/Modules/fs/`.
+- Source: [`packages/fs`](https://github.com/loopingz/webda.io/tree/main/packages/fs)
+- Related: [`@webda/aws`](../aws) for `DynamoStore` and `S3Binary` as cloud-native replacements; [`@webda/mongodb`](../mongodb) for a MongoDB-backed store; [`@webda/core`](../core) for the `Store`, `Binary`, and `Queue` base classes.
+
+<!-- README_FOOTER -->
+## Sponsors
+
+<!--
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](mailto:sponsor@webda.io)
+-->
+
+Arize AI is a machine learning observability and model monitoring platform. It helps you visualize, monitor, and explain your machine learning models. [Learn more](https://arize.com)
+
+[<img src="https://arize.com/hubfs/arize/brand/arize-logomark-1.png" width="200">](https://arize.com)
+
+Loopingz is a software development company that provides consulting and development services. [Learn more](https://loopingz.com)
+
+[<img src="https://loopingz.com/images/logo.png" width="200">](https://loopingz.com)
+
+Tellae is an innovative consulting firm specialized in cities transportation issues. We provide our clients, both public and private, with solutions to support your strategic and operational decisions. [Learn more](https://tellae.fr)
+
+[<img src="https://tellae.fr/" width="200">](https://tellae.fr)

package/lib/filebinary.service.d.ts

@@ -0,0 +1,184 @@
+import { Readable } from "stream";
+import { BinaryFile, BinaryMap, CloudBinary, CloudBinaryParameters, CoreModel, CoreModelWithBinary, CryptoService, OperationContext, WebContext } from "@webda/core";
+/** Configuration parameters for the filesystem-backed binary storage service. */
+export declare class FileBinaryParameters extends CloudBinaryParameters {
+    /**
+     * Define the folder to store objects in
+     */
+    folder: string;
+    /**
+     * Maximum size to handle
+     * @default 10Mb
+     */
+    maxSize?: number;
+    /**
+     * URL to use for direct download
+     */
+    url?: string;
+    /**
+     * Load and normalize parameters, ensuring the folder path has a trailing slash.
+     *
+     * @param params - raw parameter values
+     * @returns this instance for chaining
+     */
+    load(params: any): this;
+}
+/**
+ * FileBinary handles the storage of binary on a hard drive
+ *
+ * The structure used for now is
+ * /folder/{hash}/data
+ * /folder/{hash}/{targetStore}_{uuid}
+ * /folder/{hash}/challenge
+ *
+ * It takes one parameter
+ *  folder: "path"
+ *
+ * See Binary the general interface
+ * @category CoreServices
+ * @WebdaModda
+ */
+export declare class FileBinary<T extends FileBinaryParameters = FileBinaryParameters> extends CloudBinary<T> {
+    /**
+     * Used for hmac
+     */
+    cryptoService: CryptoService;
+    /**
+     * Load parameters
+     *
+     * @param params - raw parameter values
+     * @returns the loaded parameters
+     */
+    loadParameters(params: any): T;
+    /**
+     * Create the storage folder if needed
+     */
+    computeParameters(): void;
+    /**
+     * Register download/upload routes if a public URL is configured.
+     *
+     * Routes depend on the runtime `parameters.url` + content hash, so they're
+     * registered programmatically rather than via `@Route`.
+     *
+     * @returns this for chaining
+     */
+    init(): Promise<this>;
+    /**
+     * Download a binary with a challenge
+     *
+     * @param ctx - the web context
+     */
+    downloadBinaryLink(ctx: WebContext<any, any, {
+        hash: string;
+    }>): Promise<void>;
+    /**
+     * @override
+     */
+    _get(info: BinaryMap): Promise<Readable>;
+    /**
+     * Get signed url to download an element
+     *
+     * @param map - the binary map
+     * @param expires - expiration time in seconds
+     * @param context - the web context
+     * @returns the signed download URL
+     */
+    getSignedUrlFromMap(map: BinaryMap, expires: number, context: WebContext): Promise<string>;
+    /**
+     * Get storage path for a hash
+     *
+     * @param hash - the content hash
+     * @param postfix - optional path suffix
+     * @returns the filesystem path
+     */
+    _getPath(hash: string, postfix?: string): string;
+    /**
+     * Create a file if it does not already exist, using the given permission mode.
+     *
+     * @param filePath - path of the file to create
+     * @param mode - file permission mode
+     */
+    _touch(filePath: any, mode?: number): void;
+    /**
+     * Get token for action
+     *
+     * @param hash - the content hash
+     * @param method - HTTP method (PUT or GET)
+     * @param expiresIn - token TTL in seconds
+     * @returns the signed JWT token
+     */
+    getToken(hash: string, method: "PUT" | "GET", expiresIn?: number): Promise<string>;
+    /**
+     * Get put URL
+     *
+     * @param ctx - the operation context
+     * @returns the upload URL
+     */
+    getPutUrl(ctx: OperationContext<BinaryFile>): Promise<string>;
+    /**
+     * Will give you the redirect url
+     *
+     * @param object - the model instance
+     * @param attribute - the binary attribute name
+     * @param info - optional binary file info
+     * @param context - the operation context
+     * @returns the redirect URL and method, or undefined if already stored
+     */
+    putRedirectUrl(object: CoreModel, attribute: string, info?: BinaryFile, context?: OperationContext<BinaryFile>): Promise<{
+        url: string;
+        method: string;
+    }>;
+    /**
+     * Store the binary sent
+     *
+     * @param ctx - the web context
+     */
+    storeBinary(ctx: WebContext): Promise<void>;
+    /**
+     * @override
+     */
+    getUsageCount(hash: string): Promise<number>;
+    /**
+     * Delete any usage marker and hash
+     *
+     * @param hash - the content hash to clean
+     */
+    _cleanHash(hash: string): Promise<void>;
+    /**
+     * @override
+     */
+    _cleanUsage(hash: string, uuid: string, attribute?: string): Promise<void>;
+    /**
+     * @override
+     */
+    delete(object: CoreModelWithBinary, property: string, index?: number): Promise<void>;
+    /**
+     * Verify that a binary with the given hash exists and contains the expected challenge marker.
+     *
+     * @param hash - the content hash
+     * @param challenge - the challenge string
+     * @returns true if the challenge marker exists
+     */
+    challenge(hash: any, challenge: any): boolean;
+    /**
+     * @override
+     */
+    cascadeDelete(info: BinaryMap, uuid: string): Promise<void>;
+    /**
+     * Write a binary file's stream to the local filesystem under its content-hash directory.
+     *
+     * @param file - the binary file to store
+     * @param object - the model instance
+     * @param attribute - the binary attribute name
+     */
+    _store(file: BinaryFile, object: CoreModel, attribute: string): Promise<void>;
+    /**
+     * @override
+     */
+    store(object: CoreModel, property: string, file: BinaryFile): Promise<any>;
+    /**
+     * Clean all data
+     */
+    ___cleanData(): Promise<void>;
+}
+//# sourceMappingURL=filebinary.service.d.ts.map

package/lib/filebinary.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filebinary.service.d.ts","sourceRoot":"","sources":["../src/filebinary.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EACL,UAAU,EACV,SAAS,EAGT,WAAW,EACX,qBAAqB,EACrB,SAAS,EACT,mBAAmB,EACnB,aAAa,EAGb,gBAAgB,EAChB,UAAU,EAEX,MAAM,aAAa,CAAC;AAGrB,iFAAiF;AACjF,qBAAa,oBAAqB,SAAQ,qBAAqB;IAC7D;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAWtB;CACF;AACD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,UAAU,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAE,SAAQ,WAAW,CAAC,CAAC,CAAC;IACnG;;OAEG;IAEH,aAAa,EAAE,aAAa,CAAC;IAC7B;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAE7B;IAED;;OAEG;IACH,iBAAiB,SAKhB;IAED;;;;;;;OAOG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAgD1B;IAED;;;;OAIG;IACG,kBAAkB,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,iBAsBnE;IAED;;OAEG;IACG,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,CAM7C;IAED;;;;;;;OAOG;IACG,mBAAmB,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAQ/F;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,MAAkB,UAKjD;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,KAAA,EAAE,IAAI,SAAQ,QAO5B;IAED;;;;;;;OAOG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,GAAG,KAAK,EAAE,SAAS,GAAE,MAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAO3F;IAED;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,gBAAgB,CAAC,UAAU,CAAC,mBAOhD;IAED;;;;;;;;OAQG;IACG,cAAc,CAClB,MAAM,EAAE,SAAS,EACjB,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,UAAU,EACjB,OAAO,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,GACrC,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAsB1C;IAED;;;;OAIG;IACG,WAAW,CAAC,GAAG,EAAE,UAAU,iBA6BhC;IAED;;OAEG;IACG,aAAa,CAAC,IAAI,EAAE,MAAM,mBAO/B;IAED;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAQ5C;IAED;;OAEG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAY/E;IAED;;OAEG;IACG,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIzF;IAED;;;;;;OAMG;IACH,SAAS,CAAC,IAAI,KAAA,EAAE,SAAS,KAAA,WAGxB;IAED;;OAEG;IACG,aAAa,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,iBAEhD;IAED;;;;;;OAMG;IACG,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,iBAYlE;IAED;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAY/E;IAED;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAElC;CACF"}