@t4h.framework/fs 0.0.0-experimental-c0d4325

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tech four humans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+# @t4h.framework/fs
+
+File system claim for reading and writing files within activities.
+
+## Claim
+
+### FileSystemClaim
+
+Abstract dependency for file system operations. An activity declares this claim when it needs to read or write files. The runtime provides a concrete implementation (e.g. local disk, S3, GCS).
+
+```typescript
+import { FileSystemClaim } from '@t4h.framework/fs'
+```
+
+### Interface
+
+```typescript
+abstract class FileSystemClaim {
+  public abstract write(path: string, readable: Readable | Buffer): Binary | Promise<Binary>
+  public abstract read(path: string): Binary | Promise<Binary>
+}
+```
+
+### Usage inside an activity
+
+```typescript
+import { SyncActivity, Claim } from '@t4h.framework/core'
+import { FileSystemClaim } from '@t4h.framework/fs'
+
+class SaveReportActivity extends SyncActivity<[data: Buffer], { path: string }, any> {
+  private readonly claims = new Claim({
+    fs: FileSystemClaim,
+  })
+
+  public async toInput(data: Buffer) {
+    return { path: 'reports/output.pdf' }
+  }
+
+  public async run(input: { path: string }) {
+    const binary = await this.claims.fs.write(input.path, Buffer.from('...'))
+    return { contentType: binary.contentType }
+  }
+
+  public toOutput(output: any) {
+    return output
+  }
+}
+```
+
+### Runtime provider
+
+The runtime must supply a concrete implementation:
+
+```typescript
+{ provide: FileSystemClaim, value: new LocalFileSystemClaimImpl() }
+```

package/dist/ActivityFileSystemClaim.d.ts

@@ -0,0 +1,7 @@
+import type { Readable } from 'node:stream';
+import type { Binary } from '@t4h.framework/core';
+export declare abstract class ActivityFileSystemClaim {
+    abstract write(path: string, readable: Readable | Buffer): Binary | Promise<Binary>;
+    abstract read(path: string): Binary | Promise<Binary>;
+}
+//# sourceMappingURL=ActivityFileSystemClaim.d.ts.map

package/dist/ActivityFileSystemClaim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityFileSystemClaim.d.ts","sourceRoot":"","sources":["../src/ActivityFileSystemClaim.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAE3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAEjD,8BAAsB,uBAAuB;aAC3B,KAAK,CACnB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAC1B,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;aAEX,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAC7D"}

package/dist/ActivityFileSystemClaim.js

@@ -0,0 +1,3 @@
+export class ActivityFileSystemClaim {
+}
+//# sourceMappingURL=ActivityFileSystemClaim.js.map

package/dist/ActivityFileSystemClaim.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityFileSystemClaim.js","sourceRoot":"","sources":["../src/ActivityFileSystemClaim.ts"],"names":[],"mappings":"AAIA,MAAM,OAAgB,uBAAuB;CAO5C"}

package/dist/FileSystemClaim.d.ts

@@ -0,0 +1,7 @@
+import type { Readable } from 'node:stream';
+import type { Binary } from '@t4h.framework/core';
+export declare abstract class FileSystemClaim {
+    abstract write(path: string, readable: Readable | Buffer): Binary | Promise<Binary>;
+    abstract read(path: string): Binary | Promise<Binary>;
+}
+//# sourceMappingURL=FileSystemClaim.d.ts.map

package/dist/FileSystemClaim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystemClaim.d.ts","sourceRoot":"","sources":["../src/FileSystemClaim.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAE3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAEjD,8BAAsB,eAAe;aACnB,KAAK,CACnB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAC1B,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;aAEX,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAC7D"}

package/dist/FileSystemClaim.js

@@ -0,0 +1,3 @@
+export class FileSystemClaim {
+}
+//# sourceMappingURL=FileSystemClaim.js.map

package/dist/FileSystemClaim.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystemClaim.js","sourceRoot":"","sources":["../src/FileSystemClaim.ts"],"names":[],"mappings":"AAIA,MAAM,OAAgB,eAAe;CAOpC"}

package/dist/fs.d.ts

@@ -0,0 +1,2 @@
+export * from './FileSystemClaim.js';
+//# sourceMappingURL=fs.d.ts.map

package/dist/fs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}

package/dist/fs.js

@@ -0,0 +1,2 @@
+export * from './FileSystemClaim.js';
+//# sourceMappingURL=fs.js.map

package/dist/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@t4h.framework/fs",
+  "version": "0.0.0-experimental-c0d4325",
+  "description": "File system module for the T4H Framework",
+  "homepage": "https://github.com/tech4humans-brasil/framework/tree/main/packages/fs",
+  "bugs": "https://github.com/tech4humans-brasil/framework/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tech4humans-brasil/framework.git",
+    "directory": "packages/fs"
+  },
+  "license": "MIT",
+  "author": "Tech4Humans <contact@tech4h.com.br> (https://tech4h.com.br)",
+  "type": "module",
+  "exports": {
+    "types": "./dist/fs.d.ts",
+    "import": "./dist/fs.js"
+  },
+  "module": "./dist/fs.js",
+  "types": "./dist/fs.d.ts",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "check-types": "tsc --noEmit",
+    "lint": "eslint .",
+    "prepublishOnly": "yarn build"
+  },
+  "dependencies": {
+    "@t4h.framework/core": "workspace:^"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@t4h.framework/core": "workspace:^"
+  },
+  "packageManager": "yarn@4.12.0",
+  "engines": {
+    "node": ">=22"
+  },
+  "stableVersion": "0.0.0"
+}