@kemu-io/hs 0.10.4 → 0.10.6

package/cjs/service.d.ts

@@ -629,11 +629,30 @@ export type KemuService<T extends Record<string, any> = Record<string, any>> = {
 	/**
 	 * Registers the path to a file or folder the recipe depends on. When the recipe is exported,
 	 * the dependency will be included in the generated package.
-	 * @param key the key to use to reference the dependency.
-	 * @param path the full path in the local disk where the dependency is located. This could be a file or a directory.
+	 *
+	 * Prefix a path with `!` to exclude it from the recipe export. Both literal paths and
+	 * glob patterns are supported.
+	 *
+	 * ```ts
+	 * service.onInitialize(async (context) => {
+	 *   const widgetId = context.widgetId;
+	 *
+	 *   // Include everything in moduleA
+	 *   await service.addDependencyPath('my-dep', 'dependencies/moduleA', widgetId);
+	 *
+	 *   // Exclude the logs folder
+	 *   await service.addDependencyPath('my-dep', '!dependencies/moduleA/logs', widgetId);
+	 *
+	 *   // Include only .txt files in moduleB
+	 *   await service.addDependencyPath('my-dep', 'dependencies/moduleB/*.txt', widgetId);
+	 * });
+	 * ```
+	 *
+	 * @param key the key used to reference the dependency.
+	 * @param path the path to include (or exclude with a `!` prefix). Supports glob patterns. Pass `null` to remove the dependency.
 	 * @param widgetId the id of the widget to associate the dependency with.
 	 */
-	addDependencyPath: (key: string, path: string, widgetId: string) => Promise<void>;
+	addDependencyPath: (key: string, path: string | null, widgetId: string) => Promise<void>;
 	/**
 	 * Returns the full path of a dependency registered via `addDependencyPath`. If the dependency
 	 * is not found, the method returns `null`. During compose time, the method is likely to
@@ -736,8 +755,10 @@ export type AddSecretConfig = {
 	};
 	/** the name of the secret to store the value under */
 	envVarName: string;
-	/** the value of the secret to store */
-	envValue: string;
+	/**
+	 * the value of the secret to store. If set to null, the hub will treat this as a delete request for the mapped secret.
+	 */
+	envValue: string | null;
 	context?: string;
 	/** the uuid of the recipe that is attempting to store the secret */
 	recipeUuid: string;

package/mjs/service.d.ts

@@ -629,11 +629,30 @@ export type KemuService<T extends Record<string, any> = Record<string, any>> = {
 	/**
 	 * Registers the path to a file or folder the recipe depends on. When the recipe is exported,
 	 * the dependency will be included in the generated package.
-	 * @param key the key to use to reference the dependency.
-	 * @param path the full path in the local disk where the dependency is located. This could be a file or a directory.
+	 *
+	 * Prefix a path with `!` to exclude it from the recipe export. Both literal paths and
+	 * glob patterns are supported.
+	 *
+	 * ```ts
+	 * service.onInitialize(async (context) => {
+	 *   const widgetId = context.widgetId;
+	 *
+	 *   // Include everything in moduleA
+	 *   await service.addDependencyPath('my-dep', 'dependencies/moduleA', widgetId);
+	 *
+	 *   // Exclude the logs folder
+	 *   await service.addDependencyPath('my-dep', '!dependencies/moduleA/logs', widgetId);
+	 *
+	 *   // Include only .txt files in moduleB
+	 *   await service.addDependencyPath('my-dep', 'dependencies/moduleB/*.txt', widgetId);
+	 * });
+	 * ```
+	 *
+	 * @param key the key used to reference the dependency.
+	 * @param path the path to include (or exclude with a `!` prefix). Supports glob patterns. Pass `null` to remove the dependency.
 	 * @param widgetId the id of the widget to associate the dependency with.
 	 */
-	addDependencyPath: (key: string, path: string, widgetId: string) => Promise<void>;
+	addDependencyPath: (key: string, path: string | null, widgetId: string) => Promise<void>;
 	/**
 	 * Returns the full path of a dependency registered via `addDependencyPath`. If the dependency
 	 * is not found, the method returns `null`. During compose time, the method is likely to
@@ -736,8 +755,10 @@ export type AddSecretConfig = {
 	};
 	/** the name of the secret to store the value under */
 	envVarName: string;
-	/** the value of the secret to store */
-	envValue: string;
+	/**
+	 * the value of the secret to store. If set to null, the hub will treat this as a delete request for the mapped secret.
+	 */
+	envValue: string | null;
 	context?: string;
 	/** the uuid of the recipe that is attempting to store the secret */
 	recipeUuid: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kemu-io/hs",
   "type": "module",
-  "version": "0.10.4",
+  "version": "0.10.6",
   "description": "Kemu Hub Service - NodeJs library for creating Kemu Services",
   "author": "Kemu Pty Ltd",
   "main": "service.js",