@t4h.framework/cache 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,70 @@
+# @t4h.framework/cache
+
+Cache claim for key-value storage within activities.
+
+## Claim
+
+### CacheClaim
+
+Abstract dependency for caching serializable values. An activity declares this claim when it needs to cache data (e.g. tokens, computed results). The runtime provides a concrete implementation (e.g. Redis, in-memory).
+
+```typescript
+import { CacheClaim } from '@t4h.framework/cache'
+```
+
+### Interface
+
+```typescript
+interface CacheClaimSetOptions {
+  ttl?: number
+}
+
+abstract class CacheClaim {
+  public abstract get<T extends Serializable>(key: string): T | undefined | Promise<T | undefined>
+  public abstract set(key: string, value: Serializable, options?: CacheClaimSetOptions): Promise<void>
+}
+```
+
+### Usage inside an activity
+
+```typescript
+import { SyncActivity, Claim } from '@t4h.framework/core'
+import { CacheClaim } from '@t4h.framework/cache'
+
+class GetCachedConfigActivity extends SyncActivity<
+  [key: string],
+  { key: string },
+  any
+> {
+  private readonly claims = new Claim({
+    cache: CacheClaim,
+  })
+
+  public async toInput(key: string) {
+    return { key }
+  }
+
+  public async run(input: { key: string }) {
+    const cached = await this.claims.cache.get(input.key)
+
+    if (cached) return cached
+
+    const value = { setting: 'default' }
+    await this.claims.cache.set(input.key, value, { ttl: 3600 })
+
+    return value
+  }
+
+  public toOutput(output: any) {
+    return output
+  }
+}
+```
+
+### Runtime provider
+
+The runtime must supply a concrete implementation:
+
+```typescript
+{ provide: CacheClaim, value: new RedisCacheClaimImpl() }
+```

package/dist/ActivityCacheClaim.d.ts

@@ -0,0 +1,9 @@
+import type { Serializable } from '@t4h.framework/core';
+export interface CacheClaimSetOptions {
+    ttl?: number;
+}
+export declare abstract class CacheClaim {
+    abstract get<T extends Serializable>(key: string): T | undefined | Promise<T | undefined>;
+    abstract set(key: string, value: Serializable, options?: CacheClaimSetOptions): Promise<void>;
+}
+//# sourceMappingURL=ActivityCacheClaim.d.ts.map

package/dist/ActivityCacheClaim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityCacheClaim.d.ts","sourceRoot":"","sources":["../src/ActivityCacheClaim.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAEvD,MAAM,WAAW,oBAAoB;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,8BAAsB,UAAU;aACd,GAAG,CAAC,CAAC,SAAS,YAAY,EACxC,GAAG,EAAE,MAAM,GACV,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;aAEzB,GAAG,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,YAAY,EACnB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,IAAI,CAAC;CACjB"}

package/dist/ActivityCacheClaim.js

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

package/dist/ActivityCacheClaim.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityCacheClaim.js","sourceRoot":"","sources":["../src/ActivityCacheClaim.ts"],"names":[],"mappings":"AAMA,MAAM,OAAgB,UAAU;CAU/B"}

package/dist/CacheClaim.d.ts

@@ -0,0 +1,9 @@
+import type { Serializable } from '@t4h.framework/core';
+export interface CacheClaimSetOptions {
+    ttl?: number;
+}
+export declare abstract class CacheClaim {
+    abstract get<T extends Serializable>(key: string): T | undefined | Promise<T | undefined>;
+    abstract set(key: string, value: Serializable, options?: CacheClaimSetOptions): Promise<void>;
+}
+//# sourceMappingURL=CacheClaim.d.ts.map

package/dist/CacheClaim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CacheClaim.d.ts","sourceRoot":"","sources":["../src/CacheClaim.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAEvD,MAAM,WAAW,oBAAoB;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,8BAAsB,UAAU;aACd,GAAG,CAAC,CAAC,SAAS,YAAY,EACxC,GAAG,EAAE,MAAM,GACV,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;aAEzB,GAAG,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,YAAY,EACnB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,IAAI,CAAC;CACjB"}

package/dist/CacheClaim.js

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

package/dist/CacheClaim.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CacheClaim.js","sourceRoot":"","sources":["../src/CacheClaim.ts"],"names":[],"mappings":"AAMA,MAAM,OAAgB,UAAU;CAU/B"}

package/dist/cache.d.ts

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

package/dist/cache.d.ts.map

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

package/dist/cache.js

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

package/dist/cache.js.map

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

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@t4h.framework/cache",
+  "version": "0.0.0-experimental-c0d4325",
+  "description": "Cache module for the T4H Framework",
+  "homepage": "https://github.com/tech4humans-brasil/framework/tree/main/packages/cache",
+  "bugs": "https://github.com/tech4humans-brasil/framework/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tech4humans-brasil/framework.git",
+    "directory": "packages/cache"
+  },
+  "license": "MIT",
+  "author": "Tech4Humans <contact@tech4h.com.br> (https://tech4h.com.br)",
+  "type": "module",
+  "exports": {
+    "types": "./dist/cache.d.ts",
+    "import": "./dist/cache.js"
+  },
+  "module": "./dist/cache.js",
+  "types": "./dist/cache.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"
+}