@ketrics/ketrics-cli 0.2.0 → 0.2.2

package/dist/src/services/api-client.d.ts

@@ -1,7 +1,7 @@
 /**
  * API Client Service
  *
- * HTTP client for communicating with Ketrics Control Plane API.
+ * HTTP client for communicating with Ketrics Tenant API.
  */
 import type { EnvConfig, DeployResponse } from "../types";
 /**

package/dist/src/services/api-client.js

@@ -2,7 +2,7 @@
 /**
  * API Client Service
  *
- * HTTP client for communicating with Ketrics Control Plane API.
+ * HTTP client for communicating with Ketrics Tenant API.
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ketrics/ketrics-cli",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "CLI tool for deploying applications to Ketrics platform",
   "main": "dist/index.js",
   "bin": {

package/templates/HelloWorld/backend/package-lock.json

@@ -0,0 +1,374 @@
+{
+  "name": "app3",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "app3",
+      "version": "1.0.0",
+      "devDependencies": {
+        "@ketrics/sdk-backend": "0.7.1",
+        "@types/node": ">=24.0.0",
+        "esbuild": "^0.27.2",
+        "ts-node": "^1.7.1",
+        "typescript": "^5.3.3"
+      }
+    },
+    "node_modules/@esbuild/darwin-arm64": {
+      "version": "0.27.2",
+      "cpu": [
+        "arm64"
+      ],
+      "dev": true,
+      "license": "MIT",
+      "optional": true,
+      "os": [
+        "darwin"
+      ],
+      "engines": {
+        "node": ">=18"
+      }
+    },
+    "node_modules/@ketrics/sdk-backend": {
+      "version": "0.7.1",
+      "resolved": "https://registry.npmjs.org/@ketrics/sdk-backend/-/sdk-backend-0.7.1.tgz",
+      "integrity": "sha512-cMKOditcGh0cB5kLfrP2IGQ7gvCffeOAMhhkgdiGiGmmBnMJKwcBjfBMZtLHzFQ+F/+oR1QoMnZOsaxd8BMQZw==",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=24.0.0"
+      },
+      "peerDependencies": {
+        "@types/node": ">=24.0.0"
+      }
+    },
+    "node_modules/@types/node": {
+      "version": "25.1.0",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-25.1.0.tgz",
+      "integrity": "sha512-t7frlewr6+cbx+9Ohpl0NOTKXZNV9xHRmNOvql47BFJKcEG1CxtxlPEEe+gR9uhVWM4DwhnvTF110mIL4yP9RA==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "undici-types": "~7.16.0"
+      }
+    },
+    "node_modules/ansi-regex": {
+      "version": "2.1.1",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/ansi-styles": {
+      "version": "2.2.1",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/any-promise": {
+      "version": "1.3.0",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/arrify": {
+      "version": "1.0.1",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/chalk": {
+      "version": "1.1.3",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "ansi-styles": "^2.2.1",
+        "escape-string-regexp": "^1.0.2",
+        "has-ansi": "^2.0.0",
+        "strip-ansi": "^3.0.0",
+        "supports-color": "^2.0.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/error-ex": {
+      "version": "1.3.4",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "is-arrayish": "^0.2.1"
+      }
+    },
+    "node_modules/esbuild": {
+      "version": "0.27.2",
+      "dev": true,
+      "hasInstallScript": true,
+      "license": "MIT",
+      "bin": {
+        "esbuild": "bin/esbuild"
+      },
+      "engines": {
+        "node": ">=18"
+      },
+      "optionalDependencies": {
+        "@esbuild/aix-ppc64": "0.27.2",
+        "@esbuild/android-arm": "0.27.2",
+        "@esbuild/android-arm64": "0.27.2",
+        "@esbuild/android-x64": "0.27.2",
+        "@esbuild/darwin-arm64": "0.27.2",
+        "@esbuild/darwin-x64": "0.27.2",
+        "@esbuild/freebsd-arm64": "0.27.2",
+        "@esbuild/freebsd-x64": "0.27.2",
+        "@esbuild/linux-arm": "0.27.2",
+        "@esbuild/linux-arm64": "0.27.2",
+        "@esbuild/linux-ia32": "0.27.2",
+        "@esbuild/linux-loong64": "0.27.2",
+        "@esbuild/linux-mips64el": "0.27.2",
+        "@esbuild/linux-ppc64": "0.27.2",
+        "@esbuild/linux-riscv64": "0.27.2",
+        "@esbuild/linux-s390x": "0.27.2",
+        "@esbuild/linux-x64": "0.27.2",
+        "@esbuild/netbsd-arm64": "0.27.2",
+        "@esbuild/netbsd-x64": "0.27.2",
+        "@esbuild/openbsd-arm64": "0.27.2",
+        "@esbuild/openbsd-x64": "0.27.2",
+        "@esbuild/openharmony-arm64": "0.27.2",
+        "@esbuild/sunos-x64": "0.27.2",
+        "@esbuild/win32-arm64": "0.27.2",
+        "@esbuild/win32-ia32": "0.27.2",
+        "@esbuild/win32-x64": "0.27.2"
+      }
+    },
+    "node_modules/escape-string-regexp": {
+      "version": "1.0.5",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.8.0"
+      }
+    },
+    "node_modules/has-ansi": {
+      "version": "2.0.0",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "ansi-regex": "^2.0.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/is-arrayish": {
+      "version": "0.2.1",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/is-utf8": {
+      "version": "0.2.1",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/make-error": {
+      "version": "1.3.6",
+      "dev": true,
+      "license": "ISC"
+    },
+    "node_modules/minimist": {
+      "version": "1.2.8",
+      "dev": true,
+      "license": "MIT",
+      "funding": {
+        "url": "https://github.com/sponsors/ljharb"
+      }
+    },
+    "node_modules/mkdirp": {
+      "version": "0.5.6",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "minimist": "^1.2.6"
+      },
+      "bin": {
+        "mkdirp": "bin/cmd.js"
+      }
+    },
+    "node_modules/object-assign": {
+      "version": "4.1.1",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/parse-json": {
+      "version": "2.2.0",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "error-ex": "^1.2.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/pinkie": {
+      "version": "2.0.4",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/source-map": {
+      "version": "0.5.7",
+      "dev": true,
+      "license": "BSD-3-Clause",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/source-map-support": {
+      "version": "0.4.18",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "source-map": "^0.5.6"
+      }
+    },
+    "node_modules/strip-ansi": {
+      "version": "3.0.1",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "ansi-regex": "^2.0.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/strip-bom": {
+      "version": "2.0.0",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "is-utf8": "^0.2.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/strip-json-comments": {
+      "version": "2.0.1",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/supports-color": {
+      "version": "2.0.0",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.8.0"
+      }
+    },
+    "node_modules/ts-node": {
+      "version": "1.7.1",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "arrify": "^1.0.0",
+        "chalk": "^1.1.1",
+        "make-error": "^1.1.1",
+        "minimist": "^1.2.0",
+        "mkdirp": "^0.5.1",
+        "pinkie": "^2.0.4",
+        "source-map-support": "^0.4.0",
+        "tsconfig": "^5.0.2",
+        "v8flags": "^2.0.11",
+        "xtend": "^4.0.0",
+        "yn": "^1.2.0"
+      },
+      "bin": {
+        "ts-node": "dist/bin.js"
+      }
+    },
+    "node_modules/tsconfig": {
+      "version": "5.0.3",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "any-promise": "^1.3.0",
+        "parse-json": "^2.2.0",
+        "strip-bom": "^2.0.0",
+        "strip-json-comments": "^2.0.0"
+      }
+    },
+    "node_modules/typescript": {
+      "version": "5.9.3",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    },
+    "node_modules/undici-types": {
+      "version": "7.16.0",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.16.0.tgz",
+      "integrity": "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/user-home": {
+      "version": "1.1.1",
+      "dev": true,
+      "license": "MIT",
+      "bin": {
+        "user-home": "cli.js"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/v8flags": {
+      "version": "2.1.1",
+      "dev": true,
+      "dependencies": {
+        "user-home": "^1.1.1"
+      },
+      "engines": {
+        "node": ">= 0.10.0"
+      }
+    },
+    "node_modules/xtend": {
+      "version": "4.0.2",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.4"
+      }
+    },
+    "node_modules/yn": {
+      "version": "1.3.0",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "object-assign": "^4.1.1"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    }
+  }
+}

package/templates/{ketrics-app-v1 → HelloWorld}/backend/package.json

@@ -9,10 +9,10 @@
     "clean": "rm -rf dist"
   },
   "devDependencies": {
-    "@ketrics/sdk-backend": "^0.3.0",
-    "@types/node": "^20.10.0",
-    "esbuild": "^0.24.0",
-    "ts-node": "^10.9.2",
+    "@ketrics/sdk-backend": "0.7.1",
+    "@types/node": ">=24.0.0",
+    "esbuild": "^0.27.2",
+    "ts-node": "^1.7.1",
     "typescript": "^5.3.3"
   }
 }

package/templates/HelloWorld/backend/src/index.ts

@@ -0,0 +1,57 @@
+/**
+ * Ketrics Application Backend
+ *
+ * Exports handler functions compatible with Ketrics data-plane-api.
+ *
+ * The `ketrics` global object is automatically typed via @ketrics/sdk.
+ * No imports needed - just use `ketrics.*` directly.
+ *
+ * Available SDK features:
+ * - ketrics.tenant, ketrics.application, ketrics.requestor, ketrics.env (context)
+ * - ketrics.console (logging to CloudWatch)
+ * - ketrics.http (HTTP client for external APIs)
+ * - ketrics.Volume.connect(code) (S3-backed storage)
+ * - ketrics.DatabaseConnection.connect(code) (external databases)
+ * - ketrics.Secret.get(code) (encrypted secrets)
+ */
+
+// ============================================================================
+// Basic Handlers
+// ============================================================================
+
+import { saveFile, readFile, generateDownloadUrl, testWriteFileWithoutVolumeGrant } from "./volume";
+import { getSecret, getSecretWithoutGrant } from "./secrets";
+
+/**
+ * Echo handler - returns payload with context info
+ *
+ * @param payload - Any payload to echo back
+ * @returns Payload with additional context information
+ */
+
+const echo = async (payload: unknown) => {
+  ketrics.console.log(
+    `Echo was called by ${ketrics.requestor.type}:${ketrics.requestor.userId || ketrics.requestor.serviceAccountCode} in tenant ${ketrics.tenant.id}`,
+  );
+
+  // Only send message if requestor is a user
+
+  if (ketrics.requestor.type === "USER") {
+    await ketrics.Messages.send({
+      userId: ketrics.requestor.userId!,
+      type: "notification",
+      subject: "Echo called",
+      body: `Echo was called by ${ketrics.requestor.type}:${ketrics.requestor.email} in tenant ${ketrics.tenant.id}`,
+    });
+  }
+
+  return {
+    tenant: ketrics.tenant,
+    requestor: ketrics.requestor,
+    application: ketrics.application,
+    environment: ketrics.environment,
+    runtime: ketrics.runtime,
+  };
+};
+
+export { echo, saveFile, readFile, generateDownloadUrl, testWriteFileWithoutVolumeGrant, getSecret, getSecretWithoutGrant };

package/templates/HelloWorld/backend/src/secrets.ts

@@ -0,0 +1,17 @@
+const getSecret = async (key: string): Promise<{ value: string }> => {
+  const value = await ketrics.Secret.get("apikey");
+  if (!value) {
+    throw new Error(`Secret with key "${key}" not found`);
+  }
+  return { value };
+};
+
+const getSecretWithoutGrant = async (key: string): Promise<{ value: string }> => {
+  const value = await ketrics.Secret.get("missing-grant-secret");
+  if (!value) {
+    throw new Error(`Secret with key "${key}" not found`);
+  }
+  return { value };
+};
+
+export { getSecret, getSecretWithoutGrant };

package/templates/{ketrics-app-v1 → HelloWorld}/backend/src/volume.ts

@@ -1,3 +1,10 @@
+const testWriteFileWithoutVolumeGrant = async () => {
+  const volume = await ketrics.Volume.connect("test2");
+  const buffer = Buffer.from("This should fail");
+  const putResults = await volume.put("files/fail.txt", buffer);
+  return { putResults };
+};
+
 const saveFile = async () => {
   const volume = await ketrics.Volume.connect("test-volume");
 
@@ -45,4 +52,4 @@ const generateDownloadUrl = async () => {
   return { url: results.url };
 };
 
-export { saveFile, readFile, generateDownloadUrl };
+export { saveFile, readFile, generateDownloadUrl, testWriteFileWithoutVolumeGrant };

package/templates/{ketrics-app-v1 → HelloWorld}/frontend/src/App.tsx

@@ -65,6 +65,33 @@ function App() {
     }
   };
 
+  const handleRunTestWriteFileWithoutVolumeGrant = async () => {
+    try {
+      const data = await apiClient.run("testWriteFileWithoutVolumeGrant");
+      console.log("API Data:", data);
+    } catch (err) {
+      console.error("API Error:", err);
+    }
+  };
+
+  const handleGetSecret = async () => {
+    try {
+      const data = await apiClient.run("getSecret");
+      console.log("Secret Data:", data);
+    } catch (err) {
+      console.error("Secret Error:", err);
+    }
+  };
+
+  const handleGetSecretWithoutGrant = async () => {
+    try {
+      const data = await apiClient.run("getSecretWithoutGrant");
+      console.log("Secret Data:", data);
+    } catch (err) {
+      console.error("Secret Error:", err);
+    }
+  };
+
   return (
     <div className="app">
       <h1>Ketrics Test Application</h1>
@@ -88,6 +115,15 @@ function App() {
         <button onClick={handleRunGenerateDownloadUrl} className="button">
           Test Generate Download URL API
         </button>
+        <button onClick={handleRunTestWriteFileWithoutVolumeGrant} className="button">
+          Test Write File Without Volume Grant API
+        </button>
+        <button onClick={handleGetSecret} className="button">
+          Get Secret with Grant
+        </button>
+        <button onClick={handleGetSecretWithoutGrant} className="button">
+          Get Secret without Grant
+        </button>
       </div>
 
       {error && <p className="error">{error}</p>}

package/templates/HelloWorld/ketrics.config.json

@@ -0,0 +1,19 @@
+{
+  "name": "app3",
+  "version": "1.0.0",
+  "description": "My Ketrics application",
+  "runtime": "nodejs18",
+  "actions": [
+    "read",
+    "write"
+  ],
+  "entry": "dist/index.js",
+  "include": [
+    "dist/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "*.test.js",
+    "*.spec.js"
+  ]
+}

package/templates/HelloWorld/tests/test.echo2.json

@@ -0,0 +1,13 @@
+{
+  "endpoint": "/tenants/{{tenantId}}/applications/{{applicationId}}/functions/echo2",
+  "method": "POST",
+  "headers": {
+    "Authorization": "Bearer {{token}}",
+    "Content-Type": "application/json"
+  },
+  "body": {
+    "data": {
+      "hello": "world"
+    }
+  }
+}

package/templates/HelloWorld/tests/test.getSecret.json

@@ -0,0 +1,9 @@
+{
+  "endpoint": "/tenants/{{tenantId}}/applications/{{applicationId}}/functions/getSecret",
+  "method": "POST",
+  "headers": {
+    "Authorization": "Bearer {{token}}",
+    "Content-Type": "application/json"
+  },
+  "body": {}
+}

package/templates/HelloWorld/tests/test.getSecretWithoutGrant.json

@@ -0,0 +1,9 @@
+{
+  "endpoint": "/tenants/{{tenantId}}/applications/{{applicationId}}/functions/getSecretWithoutGrant",
+  "method": "POST",
+  "headers": {
+    "Authorization": "Bearer {{token}}",
+    "Content-Type": "application/json"
+  },
+  "body": {}
+}

package/templates/HelloWorld/tests/test.testWriteFileWithoutVolumeGrant.json

@@ -0,0 +1,9 @@
+{
+  "endpoint": "/tenants/{{tenantId}}/applications/{{applicationId}}/functions/testWriteFileWithoutVolumeGrant",
+  "method": "POST",
+  "headers": {
+    "Authorization": "Bearer {{token}}",
+    "Content-Type": "application/json"
+  },
+  "body": {}
+}

package/templates/ketrics-app-v1/.env.example

@@ -1,17 +0,0 @@
-# Ketrics Deployment Configuration
-# Copy this file to .env and fill in your values
-
-# Deployment token from Ketrics dashboard
-KETRICS_TOKEN=ktd_your-token-id_your-secret-key
-
-# API URL (default for production)
-KETRICS_API_URL=https://api.ketrics.cl/api/v1
-
-# Your tenant ID
-KETRICS_TENANT_ID=your-tenant-uuid
-
-# Application ID for this backend
-KETRICS_APPLICATION_ID=your-application-uuid
-
-# Optional: Custom authentication token (JWT) for Ketrics API
-KETRICS_AUTH_TOKEN=your-jwt-auth-token