@flightdev/babel-plugin-cache 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Flight Contributors
+
+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,49 @@
+# @flight-framework/babel-plugin-cache
+
+Babel plugin for "use cache" directive in Flight Framework.
+
+## Installation
+
+```bash
+pnpm add @flight-framework/babel-plugin-cache
+```
+
+## Usage
+
+### babel.config.js
+
+```javascript
+module.exports = {
+    plugins: [
+        ['@flight-framework/babel-plugin-cache', {
+            defaultTTL: 3600,
+        }],
+    ],
+};
+```
+
+### In Code
+
+```typescript
+async function getReviews(productId: string) {
+    "use cache";
+    return fetch(`/api/reviews/${productId}`).then(r => r.json());
+}
+```
+
+### Output
+
+```typescript
+import { cachedFn } from '@flight-framework/cache-components';
+
+const getReviews = cachedFn('getReviews', async (productId: string) => {
+    return fetch(`/api/reviews/${productId}`).then(r => r.json());
+}, { ttl: 3600 });
+```
+
+## Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `defaultTTL` | number | 3600 | Default TTL in seconds |
+| `importSource` | string | `@flight-framework/cache-components` | Import source |

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @flightdev/babel-plugin-cache
+ *
+ * Babel plugin that transforms "use cache" directive into cached function calls.
+ */
+interface PluginOptions {
+    /** Default TTL for cached functions (seconds) */
+    defaultTTL?: number;
+    /** Import source for cachedFn */
+    importSource?: string;
+    /** Name of the runtime function */
+    runtimeFn?: string;
+}
+/**
+ * Babel plugin for "use cache" directive
+ */
+declare function flightCachePlugin({ types: t }: {
+    types: any;
+}, options?: PluginOptions): any;
+
+export { type PluginOptions, flightCachePlugin as default };

package/dist/index.js

@@ -0,0 +1,140 @@
+// src/index.ts
+function flightCachePlugin({ types: t }, options = {}) {
+  const {
+    defaultTTL = 3600,
+    importSource = "@flightdev/cache-components",
+    runtimeFn = "cachedFn"
+  } = options;
+  let importIdentifier = null;
+  let needsImport = false;
+  return {
+    name: "flight-cache",
+    visitor: {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      Program: {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        enter(path) {
+          needsImport = false;
+          importIdentifier = null;
+          for (const node of path.node.body) {
+            if (node.type === "ImportDeclaration" && node.source.value === importSource) {
+              for (const specifier of node.specifiers) {
+                if (specifier.type === "ImportSpecifier" && specifier.imported?.name === runtimeFn) {
+                  importIdentifier = specifier.local;
+                  return;
+                }
+              }
+            }
+          }
+        },
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        exit(path) {
+          if (needsImport && !importIdentifier) {
+            const id = path.scope.generateUidIdentifier(runtimeFn);
+            importIdentifier = id;
+            const importDecl = t.importDeclaration(
+              [t.importSpecifier(id, t.identifier(runtimeFn))],
+              t.stringLiteral(importSource)
+            );
+            path.unshiftContainer("body", importDecl);
+          }
+        }
+      },
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      FunctionDeclaration(path) {
+        if (!hasUseCacheDirective(path)) return;
+        if (!path.node.id) return;
+        const fnName = path.node.id.name;
+        needsImport = true;
+        removeUseCacheDirective(path);
+        const arrowFn = t.arrowFunctionExpression(
+          path.node.params,
+          path.node.body,
+          path.node.async
+        );
+        const cacheCall = t.callExpression(
+          importIdentifier || t.identifier("__cachedFn"),
+          [
+            t.stringLiteral(fnName),
+            arrowFn,
+            t.objectExpression([
+              t.objectProperty(
+                t.identifier("ttl"),
+                t.numericLiteral(defaultTTL)
+              )
+            ])
+          ]
+        );
+        const varDecl = t.variableDeclaration("const", [
+          t.variableDeclarator(t.identifier(fnName), cacheCall)
+        ]);
+        path.replaceWith(varDecl);
+      },
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      ArrowFunctionExpression(path) {
+        if (!hasUseCacheDirective(path)) return;
+        const parent = path.parentPath;
+        if (!parent.isVariableDeclarator()) return;
+        const id = parent.node.id;
+        if (!t.isIdentifier(id)) return;
+        const fnName = id.name;
+        needsImport = true;
+        removeUseCacheDirective(path);
+        const newArrowFn = t.arrowFunctionExpression(
+          path.node.params,
+          path.node.body,
+          path.node.async
+        );
+        const cacheCall = t.callExpression(
+          importIdentifier || t.identifier("__cachedFn"),
+          [
+            t.stringLiteral(fnName),
+            newArrowFn,
+            t.objectExpression([
+              t.objectProperty(
+                t.identifier("ttl"),
+                t.numericLiteral(defaultTTL)
+              )
+            ])
+          ]
+        );
+        path.replaceWith(cacheCall);
+      }
+    }
+  };
+}
+function hasUseCacheDirective(path) {
+  const body = path.node.body;
+  if (body.type !== "BlockStatement") return false;
+  for (const stmt of body.directives || []) {
+    if (stmt.value.value === "use cache") {
+      return true;
+    }
+  }
+  if (body.body.length > 0) {
+    const first = body.body[0];
+    if (first.type === "ExpressionStatement" && first.expression.type === "StringLiteral" && first.expression.value === "use cache") {
+      return true;
+    }
+  }
+  return false;
+}
+function removeUseCacheDirective(path) {
+  const body = path.node.body;
+  if (body.type !== "BlockStatement") return;
+  if (body.directives) {
+    body.directives = body.directives.filter(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (d) => d.value.value !== "use cache"
+    );
+  }
+  if (body.body.length > 0) {
+    const first = body.body[0];
+    if (first.type === "ExpressionStatement" && first.expression.type === "StringLiteral" && first.expression.value === "use cache") {
+      body.body.shift();
+    }
+  }
+}
+export {
+  flightCachePlugin as default
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@flightdev/babel-plugin-cache",
+  "version": "0.0.2",
+  "description": "Babel plugin for 'use cache' directive in Flight Framework",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "@babel/core": ">=7.0.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.24.0",
+    "@types/babel__core": "^7.20.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^2.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "flight",
+    "babel",
+    "plugin",
+    "cache",
+    "directive"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts",
+    "dev": "tsup src/index.ts --format esm --dts --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  }
+}