@sinch/functions-runtime 0.3.9 → 0.4.1

package/dist/index.d.ts

@@ -760,7 +760,7 @@ export declare function createPieBuilder(): PieSvamlBuilder;
 /**
  * Cache interface for Sinch Functions
  *
- * Both dev (LocalCache) and prod (DaprCache) implement this interface,
+ * Both dev (LocalCache) and prod (ApiBackedCache) implement this interface,
  * allowing seamless package swap during deployment.
  */
 /**
@@ -865,6 +865,46 @@ export interface IFunctionCache {
 	 */
 	getMany<T = unknown>(keys: string[]): Promise<Record<string, T | null>>;
 }
+/**
+ * Storage interface for Sinch Functions
+ *
+ * Both dev (LocalStorage) and prod (S3Storage) implement this interface,
+ * allowing seamless package swap during deployment.
+ */
+/**
+ * Function storage interface
+ *
+ * Provides file/blob storage for persistent data.
+ * In development, uses the local filesystem (./storage/ directory).
+ * In production, uses S3 with local disk caching for reads.
+ *
+ * Access via `context.storage` — do not construct directly.
+ *
+ * @example
+ * ```typescript
+ * // Write a file
+ * await context.storage.write('reports/daily.json', JSON.stringify(data));
+ *
+ * // Read it back
+ * const buf = await context.storage.read('reports/daily.json');
+ * const data = JSON.parse(buf.toString());
+ *
+ * // List files
+ * const files = await context.storage.list('reports/');
+ *
+ * // Check existence and delete
+ * if (await context.storage.exists('reports/old.json')) {
+ *   await context.storage.delete('reports/old.json');
+ * }
+ * ```
+ */
+export interface IFunctionStorage {
+	write(key: string, data: string | Buffer): Promise<void>;
+	read(key: string): Promise<Buffer>;
+	list(prefix?: string): Promise<string[]>;
+	exists(key: string): Promise<boolean>;
+	delete(key: string): Promise<void>;
+}
 /**
  * Function configuration with environment variables
  */
@@ -932,6 +972,37 @@ export interface FunctionContext {
 	 * Available when `ENABLE_NUMBERS_API=true` is set.
 	 */
 	numbers?: NumbersService;
+	/**
+	 * Persistent file/blob storage.
+	 * Local filesystem during development, S3-backed in production.
+	 * @see {@link IFunctionStorage} for available methods
+	 */
+	storage: IFunctionStorage;
+	/**
+	 * File path to a SQLite database for persistent structured data.
+	 * The database file is managed by a Litestream sidecar in production
+	 * (continuous WAL replication to S3). In development, it's a local file.
+	 *
+	 * Use any SQLite library — `sql.js` (pure WASM, no native deps) or
+	 * `better-sqlite3` (native C++, fastest but requires build tooling).
+	 *
+	 * @example
+	 * ```typescript
+	 * // sql.js (recommended — works everywhere)
+	 * import initSqlJs from 'sql.js';
+	 * const SQL = await initSqlJs();
+	 * const buf = existsSync(context.database) ? readFileSync(context.database) : undefined;
+	 * const db = new SQL.Database(buf);
+	 * db.run('CREATE TABLE IF NOT EXISTS kv (key TEXT PRIMARY KEY, value TEXT)');
+	 * writeFileSync(context.database, Buffer.from(db.export()));
+	 *
+	 * // better-sqlite3 (fastest — needs python3/make/g++)
+	 * import Database from 'better-sqlite3';
+	 * const db = new Database(context.database);
+	 * db.exec('CREATE TABLE IF NOT EXISTS kv (key TEXT PRIMARY KEY, value TEXT)');
+	 * ```
+	 */
+	database: string;
 	/** Read a file from the assets/ directory (private, not served over HTTP) */
 	assets(filename: string): Promise<string>;
 }
@@ -1221,6 +1292,12 @@ export declare function createLenientJsonParser(options?: JsonParsingOptions): (
  * @internal
  */
 export declare function setupJsonParsing(app: Express, options?: JsonParsingOptions): Express;
+/**
+ * Declarative auth configuration exported by user functions.
+ * - string[] — protect specific handler names
+ * - '*' — protect all handlers
+ */
+export type AuthConfig = string[] | "*";
 /**
  * Get the landing page HTML content
  * Exported so production runtime can also use it
@@ -1258,6 +1335,12 @@ export interface RequestHandlerOptions {
 	logger?: (...args: unknown[]) => void;
 	/** Enable landing page for browser requests at root (default: true) */
 	landingPageEnabled?: boolean;
+	/** Declarative auth config from user module (string[] or '*') */
+	authConfig?: AuthConfig;
+	/** API key for Basic Auth validation */
+	authKey?: string;
+	/** API secret for Basic Auth validation */
+	authSecret?: string;
 	/** Called when request starts */
 	onRequestStart?: (data: {
 		functionName: string;
@@ -2292,6 +2375,18 @@ export declare class LocalCache implements IFunctionCache {
  * @internal Dev-only factory — access cache via `context.cache`
  */
 export declare function createCacheClient(_projectId?: string, _functionName?: string): IFunctionCache;
+export declare class LocalStorage implements IFunctionStorage {
+	private baseDir;
+	constructor(baseDir?: string);
+	private resolvePath;
+	write(key: string, data: string | Buffer): Promise<void>;
+	read(key: string): Promise<Buffer>;
+	list(prefix?: string): Promise<string[]>;
+	exists(key: string): Promise<boolean>;
+	delete(key: string): Promise<void>;
+	private walkDir;
+}
+export declare function createStorageClient(baseDir?: string): LocalStorage;
 /**
  * Tunnel Client for Sinch Functions
  *
@@ -2380,7 +2475,10 @@ export declare class SecretsLoader {
 	 */
 	loadCustomSecrets(secretNames?: string[]): Promise<Record<string, string>>;
 	/**
-	 * Check if keytar is available
+	 * Check if the native keychain is available.
+	 * Always true — no native npm deps required. The underlying OS tool
+	 * (secret-tool, security, CredManager) may still be absent, in which
+	 * case getPassword() silently returns null per credential.
 	 */
 	isAvailable(): Promise<boolean>;
 }