@t4h.framework/fs 0.9.4 → 0.9.5

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @t4h.framework/fs
 
+## 0.9.5
+
+### Patch Changes
+
+- [#174](https://github.com/tech4humans-brasil/framework/pull/174) [`7cd75e4`](https://github.com/tech4humans-brasil/framework/commit/7cd75e4f557d9f5fbe3e486d5a3981186fa38797) Thanks [@gusteycamargo](https://github.com/gusteycamargo)! - Adds `asset(path)`, which reads a file shipped with the project.
+
+  Fonts a PDF embeds, images a template draws, a fixed lookup table: they belong
+  to the project, not to a run. Reading them with `readFileSync` appears to work
+  and then costs dearly, because every primitive persists its input — a value
+  holding a `Buffer` is serialized whole, once per activity that receives it, so
+  a 1.5 MB font used by a workflow that runs per record is written into the
+  history per record. `asset` returns a `Binary`, which travels as a reference
+  and is read only where the bytes are needed.
+
+  Declare the files in `framework.config.ts` under `build.assets` (renamed from
+  `build.additionalFiles`, with no fallback — rename the key to keep shipping
+  files). `build` now records the copied paths and `publish` sends them, so a
+  runtime knows which entries of the artifact are assets. `AssetClaim` is the
+  contract each runtime implements.
+
 ## 0.9.4
 
 ### Patch Changes

package/dist/AssetClaim.d.ts

@@ -0,0 +1,6 @@
+import { type Binary } from '@t4h.framework/core';
+export declare abstract class AssetClaim {
+    abstract resolve(path: string): Binary | Promise<Binary>;
+}
+export declare function asset(path: string): Promise<Binary>;
+//# sourceMappingURL=AssetClaim.d.ts.map

package/dist/AssetClaim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetClaim.d.ts","sourceRoot":"","sources":["../src/AssetClaim.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAExD,8BAAsB,UAAU;aACd,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAChE;AAED,wBAAsB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAIzD"}

package/dist/AssetClaim.js

@@ -0,0 +1,8 @@
+import { Claim } from '@t4h.framework/core';
+export class AssetClaim {
+}
+export async function asset(path) {
+    const claims = new Claim({ assets: AssetClaim });
+    return await claims.assets.resolve(path);
+}
+//# sourceMappingURL=AssetClaim.js.map

package/dist/AssetClaim.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetClaim.js","sourceRoot":"","sources":["../src/AssetClaim.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAe,MAAM,qBAAqB,CAAA;AAExD,MAAM,OAAgB,UAAU;CAE/B;AAED,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,IAAY;IACtC,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;IAEhD,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAC1C,CAAC"}

package/dist/fs.d.ts

@@ -1,3 +1,4 @@
+export * from './AssetClaim.js';
 export * from './FileSystemClaim.js';
 export * from './activities/FileJoinActivity.js';
 export * from './activities/FileReadActivity.js';

package/dist/fs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA"}
+{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,sBAAsB,CAAA;AACpC,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA"}

package/dist/fs.js

@@ -1,3 +1,4 @@
+export * from './AssetClaim.js';
 export * from './FileSystemClaim.js';
 export * from './activities/FileJoinActivity.js';
 export * from './activities/FileReadActivity.js';

package/dist/fs.js.map

@@ -1 +1 @@
-{"version":3,"file":"fs.js","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA"}
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,sBAAsB,CAAA;AACpC,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t4h.framework/fs",
-  "version": "0.9.4",
+  "version": "0.9.5",
   "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",