@microsoft/rayfin-functions 1.20.0

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+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,43 @@
+# @microsoft/rayfin-functions
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which
+includes all source code repositories in our GitHub organizations.
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+For security reporting information, locations, contact information, and policies,
+please review the latest guidance for Microsoft repositories at
+[https://aka.ms/SECURITY.md](https://aka.ms/SECURITY.md).
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services.
+Authorized use of Microsoft trademarks or logos must follow the [Microsoft Trademark and Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos is subject to those third parties' policies.
+
+## License
+
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+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/dist/Functions.d.ts

@@ -0,0 +1,108 @@
+/**
+ * @fileoverview Functions API client for invoking serverless functions.
+ * This file provides an API for invoking serverless functions through the Rayfin platform.
+ */
+import { ApiClient, SdkError, NetworkError } from '@microsoft/rayfin-lib';
+/**
+ * Functions error specific to the Rayfin SDK.
+ */
+export declare class FunctionsError extends SdkError {
+    constructor(message: string, code?: string);
+}
+/**
+ * Parameters for a function invocation request.
+ */
+export interface FunctionInvocationParams {
+    /**
+     * The name of the function to invoke.
+     */
+    functionName: string;
+    /**
+     * Optional parameters to pass to the function.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Optional headers to include with the invocation request.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * Response from a function invocation.
+ */
+export interface FunctionInvocationResponse<T = any> {
+    /**
+     * The name of the function that was invoked.
+     */
+    functionName: string;
+    /**
+     * A unique identifier for this invocation.
+     */
+    invocationId: string;
+    /**
+     * Status of the function invocation (Success, Failed, etc.)
+     */
+    status: string;
+    /**
+     * The output from the function. This can be a string containing JSON or any other data.
+     * When it's a JSON string, it will typically have its own nested structure with functionName,
+     * invocationId, status, output, and errors fields.
+     */
+    output: string | T;
+    /**
+     * Any errors that occurred during the function invocation.
+     */
+    errors: Array<string | Record<string, any>>;
+}
+/**
+ * Main Functions class for Rayfin.
+ * This class provides the high-level API for invoking serverless functions.
+ */
+export declare class FunctionsApi {
+    private apiClient;
+    static readonly errors: {
+        FunctionsError: typeof FunctionsError;
+        NetworkError: typeof NetworkError;
+        SdkError: typeof SdkError;
+    };
+    /**
+     * @param apiClient An instance of ApiClient to be used for API requests.
+     */
+    constructor(apiClient: ApiClient);
+    /**
+     * Helper method to parse the output field of a function response when it contains a JSON string.
+     *
+     * @param response The function invocation response
+     * @returns The parsed output object, or the original output if it's not valid JSON
+     */
+    parseOutput<T = any, R = any>(response: FunctionInvocationResponse<T>): R | string | T;
+    /**
+     * Invokes a serverless function with the given parameters.
+     *
+     * @param params The function invocation parameters
+     * @returns A promise that resolves with the function invocation response
+     * @throws {FunctionsError} If the function invocation fails
+     * @throws {NetworkError} For network-related issues
+     * @throws {SdkError} For any other unexpected SDK errors
+     *
+     * @example
+     * ```typescript
+     * const response = await functions.invoke({
+     *   functionName: 'processOrder',
+     *   parameters: {
+     *     orderId: '12345',
+     *     amount: 99.99
+     *   }
+     * });
+     *
+     * // Direct access to the response
+     * console.log(response.status);
+     * console.log(response.invocationId);
+     *
+     * // Parse the output field if it contains JSON
+     * const parsedOutput = functions.parseOutput(response);
+     * console.log(parsedOutput); // Will contain the actual result
+     * ```
+     */
+    invoke<T = any>(params: FunctionInvocationParams): Promise<FunctionInvocationResponse<T>>;
+}
+//# sourceMappingURL=Functions.d.ts.map

package/dist/Functions.js

@@ -0,0 +1,129 @@
+/**
+ * @fileoverview Functions API client for invoking serverless functions.
+ * This file provides an API for invoking serverless functions through the Rayfin platform.
+ */
+import { SdkError, NetworkError } from '@microsoft/rayfin-lib';
+import { FUNCTIONS_INVOKE_PATH } from '@microsoft/rayfin-lib';
+/**
+ * Functions error specific to the Rayfin SDK.
+ */
+export class FunctionsError extends SdkError {
+    constructor(message, code) {
+        super(message, code || 'FUNCTIONS_ERROR');
+    }
+}
+/**
+ * Main Functions class for Rayfin.
+ * This class provides the high-level API for invoking serverless functions.
+ */
+export class FunctionsApi {
+    apiClient;
+    // Static access to custom errors for easy import by consumers
+    static errors = {
+        FunctionsError,
+        NetworkError,
+        SdkError,
+    };
+    /**
+     * @param apiClient An instance of ApiClient to be used for API requests.
+     */
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    /**
+     * Helper method to parse the output field of a function response when it contains a JSON string.
+     *
+     * @param response The function invocation response
+     * @returns The parsed output object, or the original output if it's not valid JSON
+     */
+    parseOutput(response) {
+        if (typeof response.output === 'string') {
+            try {
+                // Try to parse the output as JSON
+                const parsedOutput = JSON.parse(response.output);
+                // If the parsed output has its own 'output' field, return that
+                if (parsedOutput &&
+                    typeof parsedOutput === 'object' &&
+                    'output' in parsedOutput) {
+                    return parsedOutput.output;
+                }
+                // Otherwise return the entire parsed object
+                return parsedOutput;
+            }
+            catch (e) {
+                // If parsing fails, return the original string
+                return response.output;
+            }
+        }
+        // If output is not a string, return it as is
+        return response.output;
+    }
+    /**
+     * Invokes a serverless function with the given parameters.
+     *
+     * @param params The function invocation parameters
+     * @returns A promise that resolves with the function invocation response
+     * @throws {FunctionsError} If the function invocation fails
+     * @throws {NetworkError} For network-related issues
+     * @throws {SdkError} For any other unexpected SDK errors
+     *
+     * @example
+     * ```typescript
+     * const response = await functions.invoke({
+     *   functionName: 'processOrder',
+     *   parameters: {
+     *     orderId: '12345',
+     *     amount: 99.99
+     *   }
+     * });
+     *
+     * // Direct access to the response
+     * console.log(response.status);
+     * console.log(response.invocationId);
+     *
+     * // Parse the output field if it contains JSON
+     * const parsedOutput = functions.parseOutput(response);
+     * console.log(parsedOutput); // Will contain the actual result
+     * ```
+     */
+    async invoke(params) {
+        try {
+            // Basic validation
+            if (!params.functionName) {
+                throw new FunctionsError('Function name is required for invocation', 'MISSING_FUNCTION_NAME');
+            }
+            const { functionName, parameters, headers } = params;
+            // Prepare the request payload
+            const payload = {
+                functionName,
+                parameters: parameters || {},
+            };
+            // Make the POST request to the functions/invoke endpoint
+            const response = await this.apiClient.post(FUNCTIONS_INVOKE_PATH, payload, { headers });
+            // Check for function errors in the response
+            if (response.errors && response.errors.length > 0) {
+                const errorMessage = typeof response.errors[0] === 'string'
+                    ? response.errors[0]
+                    : JSON.stringify(response.errors[0]);
+                throw new FunctionsError(`Function invocation failed: ${errorMessage}`, 'FUNCTION_EXECUTION_ERROR');
+            }
+            // Check for failed status
+            if (response.status.toLowerCase() !== 'success' &&
+                response.status.toLowerCase() !== 'succeeded') {
+                throw new FunctionsError(`Function invocation failed with status: ${response.status}`, 'FUNCTION_EXECUTION_ERROR');
+            }
+            return response;
+        }
+        catch (error) {
+            // Re-throw specific SDK errors
+            if (error instanceof FunctionsError ||
+                error instanceof NetworkError ||
+                error instanceof SdkError) {
+                throw error;
+            }
+            // Wrap other errors in a FunctionsError
+            throw new FunctionsError(`An unexpected error occurred during function invocation: ${error.message || error}`, 'UNKNOWN_FUNCTION_ERROR');
+        }
+    }
+}
+//# sourceMappingURL=Functions.js.map

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { FunctionsApi } from './Functions';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,2 @@
+export { FunctionsApi } from './Functions';
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@microsoft/rayfin-functions",
+  "version": "1.20.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "!dist/**/__tests__/**",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "eslint": "^9.28.0",
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.3",
+    "@vitest/coverage-v8": "~3.2.4",
+    "rimraf": "~6.0.1"
+  },
+  "dependencies": {
+    "@microsoft/rayfin-lib": "1.20.0"
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com",
+    "access": "restricted"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/project-rayfin.git",
+    "directory": "packages/typescript-sdk/functions"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rimraf dist && rimraf .tsbuildinfo",
+    "test": "vitest run"
+  }
+}