jfrog-workers 0.17.0 → 0.19.0

package/dist/index.d.ts

@@ -1,4 +1,41 @@
-import { AxiosInstance } from "axios";
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+export interface ExtendedAxios {
+    /**
+     * Triggers an HTTP GET request and does not wait for the response (fire-and-forget).
+     * Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
+     */
+    getAndForget: <D = any, P = any>(url: string, config?: AxiosRequestConfig<D, P>) => void;
+    /**
+     * Triggers an HTTP PUT request and does not wait for the response (fire-and-forget).
+     * Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
+     */
+    putAndForget: <D = any, P = any>(url: string, data?: D, config?: AxiosRequestConfig<D, P>) => void;
+    /**
+     * Triggers an HTTP POST request and does not wait for the response (fire-and-forget).
+     * Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
+     */
+    postAndForget: <D = any, P = any>(url: string, data?: D, config?: AxiosRequestConfig<D, P>) => void;
+    /**
+     * Triggers an HTTP DELETE request and does not wait for the response (fire-and-forget).
+     * Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
+     */
+    deleteAndForget: <D = any, P = any>(url: string, config?: AxiosRequestConfig<D, P>) => void;
+    /**
+     * Triggers an HTTP HEAD request and does not wait for the response (fire-and-forget).
+     * Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
+     */
+    headAndForget: <D = any, P = any>(url: string, config?: AxiosRequestConfig<D, P>) => void;
+    /**
+     * Triggers an HTTP PATCH request and does not wait for the response (fire-and-forget).
+     * Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
+     */
+    patchAndForget: <D = any, P = any>(url: string, data?: D, config?: AxiosRequestConfig<D, P>) => void;
+    /**
+     * Triggers an HTTP REQUEST and does not wait for the response (fire-and-forget).
+     * Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
+     */
+    requestAndForget: <D = any, P = any>(config: AxiosRequestConfig<D, P>) => void;
+}
 /**
  * Response returned by JFrog platform API
  */
@@ -73,7 +110,7 @@ export interface PlatformClients {
     /**
      * HTTP client (axios) to perform requests to the outside
      */
-    axios: Pick<AxiosInstance, 'get' | 'put' | 'post' | 'delete' | 'head' | 'patch' | 'request'>;
+    axios: Pick<AxiosInstance, 'get' | 'put' | 'post' | 'delete' | 'head' | 'patch' | 'request'> & ExtendedAxios;
 }
 export interface PlatformSecrets {
     /**
@@ -132,6 +169,29 @@ export interface PlatformHttpClientError {
      */
     status: number;
 }
+export interface PlatformCrypto {
+    /**
+     * Computes a cryptographic hash of the given data
+     * @param {string} algorithm - The hash algorithm to use. Supported: 'sha256', 'sha512'
+     * @param {string} data - The data to hash
+     * @param {string} encoding - The output encoding. Defaults to 'hex'
+     */
+    hash(algorithm: 'sha256' | 'sha512', data: string, encoding?: 'hex' | 'base64'): string;
+    /**
+     * Computes an HMAC of the given data using the given key
+     * @param {string} algorithm - The hash algorithm to use. Supported: 'sha256', 'sha512'
+     * @param {string} key - The HMAC key
+     * @param {string} data - The data to authenticate
+     * @param {string} encoding - The output encoding. Defaults to 'hex'
+     */
+    hmac(algorithm: 'sha256' | 'sha512', key: string, data: string, encoding?: 'hex' | 'base64'): string;
+    /**
+     * Generates cryptographically secure random bytes
+     * @param {number} size - The number of random bytes to generate
+     * @param {string} encoding - The output encoding. Defaults to 'hex'
+     */
+    randomBytes(size: number, encoding?: 'hex' | 'base64'): string;
+}
 export interface PlatformContext {
     /**
      * HTTP clients to perform requests to your JFrog platform or to the outside
@@ -160,6 +220,10 @@ export interface PlatformContext {
      * NOTE: The state is limited in size and number of items. Check the Worker documentation for more details.
      */
     state: StateManager;
+    /**
+     * Utility to compute cryptographic hashes, HMACs, and generate random bytes
+     */
+    crypto: PlatformCrypto;
     /**
      * Will wait for the number of millisecond.
      * The waiting time is limited by the execution time of the function.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jfrog-workers",
-  "version": "0.17.0",
+  "version": "0.19.0",
   "description": "JFrog workers interfaces",
   "homepage": "https://github.com/jfrog/workers-sample",
   "contributors": [
@@ -33,9 +33,9 @@
     "url": "git+https://github.com/jfrog/workers-sample.git"
   },
   "dependencies": {
-    "axios": "1.18.1"
+    "axios": "1.20.0"
   },
   "devDependencies": {
-    "typescript": "^6.0.3"
+    "typescript": "^7.0.2"
   }
 }