@shushed/helpers 0.0.152 → 0.0.153-main-20250905115441

package/dist/index.d.ts

@@ -1,11 +1,10 @@
 import { JSONSchemaType } from 'ajv';
 import { DeepRedact } from '@hackylabs/deep-redact';
-import { Firestore, DocumentReference } from '@google-cloud/firestore';
+import { Firestore } from '@google-cloud/firestore';
 import { PubSub, Message as Message$1, Topic, Subscription } from '@google-cloud/pubsub';
 import { Context } from 'co-body';
 import * as _google_cloud_scheduler_build_protos_protos from '@google-cloud/scheduler/build/protos/protos';
 import { CloudSchedulerClient } from '@google-cloud/scheduler';
-import { SecretManagerServiceClient } from '@google-cloud/secret-manager';
 import { BigQuery } from '@google-cloud/bigquery';
 import { RedisClientType } from 'redis';
 import { RateLimiterRedis } from 'rate-limiter-flexible';
@@ -33534,6 +33533,7 @@ declare class Runtime {
 
 declare const isPubSubRequest: (headers: Record<string, string>) => boolean;
 declare const isCronMessage: (headers: Record<string, string>) => boolean;
+declare const isRespectfulNudge: (headers: Record<string, string>) => boolean;
 declare const isCloudTask: (headers: Record<string, string>) => boolean;
 declare const validateGoogleAuth: (opts: Opts & {
     serviceAccount?: string | null | false;
@@ -33551,21 +33551,78 @@ declare global {
 declare function getFirestore(systemEnvName: string): Firestore;
 type PromisifiedFn<F extends (...args: any[]) => any> = (...args: Parameters<F>) => Promise<Awaited<ReturnType<F>>>;
 declare function createHandlerDecorator<TSettings, TRequiredO extends object = {}, TRequiredH extends object = {}>(decoratorFactory: <C, O, H extends TRequiredH, H2 extends H, R>(settings: TSettings) => (handler: (c: C, o: O & TRequiredO, h: H2) => R) => (c: C, o: O & TRequiredO, h: H2) => R | Promise<R>): <C, O, H extends TRequiredH, H2 extends H, R>(settings: TSettings) => (handler: (c: C, o: O & TRequiredO, h: H2) => R) => (c: C, o: O & TRequiredO, h: H2) => R | Promise<R>;
+declare function getSecret(runtime: Runtime, name: string, accessToken: string): Promise<string>;
+declare const getAccessToken: () => Promise<string>;
 
 type Level = 'env' | 'workflow' | 'trigger';
+type SetOptions = {
+    ephemeralMs?: number;
+    ignoreStores?: Array<'redis'>;
+    encrypted: boolean;
+    encryptionKey?: string | undefined;
+};
+type GetOptions = {
+    isEphemeral?: boolean;
+    encrypted?: boolean;
+    encryptionKey?: string | undefined;
+    expirationMarginMs?: number;
+    store?: 'inMemory' | 'global' | 'redis';
+};
+type ValueDetails = {
+    createdAt: number;
+    expiresAt: number;
+    value: string;
+    valid: boolean;
+    fetch?: () => Promise<string>;
+};
+declare global {
+    var IN_MEMORY_REF: undefined | {
+        env: Record<string, Record<string, string>>;
+        workflow: Record<string, Record<string, string>>;
+        trigger: Record<string, Record<string, string>>;
+    };
+}
 declare class EnvEngine extends Runtime {
-    docRef: Record<Level, DocumentReference>;
+    globalInMemoryRef: {
+        env: Record<string, string>;
+        workflow: Record<string, string>;
+        trigger: Record<string, string>;
+    };
+    inMemoryRef: {
+        env: Record<string, string>;
+        workflow: Record<string, string>;
+        trigger: Record<string, string>;
+    };
+    private docRef;
     private store;
-    constructor(opts: Opts, firestore: Firestore);
+    private _envCache;
+    constructor(opts: Opts, firestore?: any);
+    private initializeDocRef;
+    set(envs: Array<{
+        name: string;
+        value: string;
+    }>, level: Level, options?: SetOptions): Promise<void>;
     set(envs: Array<{
         name: string;
         value: string;
-    }>, level?: Level, encryptWithValue?: string): Promise<undefined>;
-    private initializeIfNeeded;
+    }>, level: Level, encryptWithValue?: string): Promise<void>;
+    private getFirestoreStore;
+    get<T extends ReadonlyArray<string>>(keys: T, level?: Level, options?: GetOptions): Promise<{
+        [K in T[number]]: string;
+    }>;
     get<T extends ReadonlyArray<string>>(keys: T, level?: Level, decryptWithValue?: string): Promise<{
         [K in T[number]]: string;
     }>;
-    get(key: string, level?: Level, decryptWithValue?: string): Promise<string>;
+    get<M extends string, T extends readonly [M] = [M]>(key: M, level?: Level, options?: GetOptions): Promise<string>;
+    get<M extends string, T extends readonly [M] = [M]>(key: M, level?: Level, decryptWithValue?: string): Promise<string>;
+    _get<T extends ReadonlyArray<string>>(keysParsed: T, level: Level | undefined, options: GetOptions): Promise<{
+        [K in T[number]]: ValueDetails;
+    }>;
+    withGoogleAccessToken(): <T extends unknown>(fn: (value: string, requestCacheRefresh?: (() => void) | undefined) => T | Promise<T>) => Promise<T>;
+    withSecret(key: string): <T extends unknown>(fn: (value: string, requestCacheRefresh?: (() => void) | undefined) => T | Promise<T>) => Promise<T>;
+    with<M extends string>(key: M, level?: Level, options?: SetOptions & {
+        fetch?: () => Promise<string>;
+    }): <T extends any>(fn: (value: string, requestCacheRefresh?: () => void) => Promise<T> | T) => Promise<T>;
 }
 
 type Message = {
@@ -33781,8 +33838,7 @@ declare class SchedulerHelper extends Runtime {
 }
 
 declare class Secrets extends Runtime {
-    private secretsManagerClient;
-    constructor(opts: Opts, secretsManagerClient: SecretManagerServiceClient);
+    constructor(opts: Opts);
     getSecret(name: string): Promise<string>;
 }
 
@@ -34067,6 +34123,7 @@ interface ActionHelperOptions {
         api?: {
             matchByPartialQueryString?: string | RegExp;
             havingApiKey?: boolean;
+            roles: Array<string>;
         };
         pubsub?: {
             matchByPubSubSubscriptionName?: string | RegExp;
@@ -34106,6 +34163,7 @@ type RequiredTriggerOptions = {
 declare class ActionHelper<C extends Record<string, any>, O extends RequiredTriggerOptions, R> {
     private onExecuteFunction;
     actionOptions: ActionHelperOptions;
+    flags: Record<string, boolean>;
     opts: O | null;
     config: C | null;
     runtime: Runtime | null;
@@ -34131,7 +34189,7 @@ declare class ActionHelper<C extends Record<string, any>, O extends RequiredTrig
         request: RateLimiterRedis;
     };
     protected preOnExecute(): Promise<void>;
-    onExecute(config: C, opts: O, message: null | ReceivedMessage): Promise<Awaited<R>>;
+    onExecute(config: C, opts: O, message: null | ReceivedMessage, flags?: Array<string>): Promise<Awaited<R>>;
     static create<C extends Record<string, any>, O extends RequiredTriggerOptions, R>(options: ActionHelperOptions, onExecuteFunction: (config: C, opts: O, message: ReceivedMessage | null, actionHelper: ActionHelper<C, O, R>) => R): ActionHelper<C, O, R>;
 }
 
@@ -34430,11 +34488,14 @@ declare const index_TriggerHelper: typeof TriggerHelper;
 type index_TriggerOnCreateOptions = TriggerOnCreateOptions;
 type index_TriggerOnExecuteOptions = TriggerOnExecuteOptions;
 declare const index_createHandlerDecorator: typeof createHandlerDecorator;
+declare const index_getAccessToken: typeof getAccessToken;
 declare const index_getEventTime: typeof getEventTime;
 declare const index_getFirestore: typeof getFirestore;
+declare const index_getSecret: typeof getSecret;
 declare const index_isCloudTask: typeof isCloudTask;
 declare const index_isCronMessage: typeof isCronMessage;
 declare const index_isPubSubRequest: typeof isPubSubRequest;
+declare const index_isRespectfulNudge: typeof isRespectfulNudge;
 declare const index_parseDateOrDefault: typeof parseDateOrDefault;
 declare const index_sanitize: typeof sanitize;
 declare const index_sanitizeToString: typeof sanitizeToString;
@@ -34443,7 +34504,7 @@ declare const index_slugify: typeof slugify;
 declare const index_validate: typeof validate;
 declare const index_validateGoogleAuth: typeof validateGoogleAuth;
 declare namespace index {
-  export { index_ActionHelper as ActionHelper, type index_ActionHelperOptions as ActionHelperOptions, index_AirtableHelper as AirtableHelper, index_BigQueryHelper as BigQueryHelper, index_CloudTasksHelper as CloudTasksHelper, index_DatoHelper as DatoHelper, index_EnvEngine as EnvEngine, type index_ILogging as ILogging, index_JWKSHelper as JWKSHelper, index_Logging as Logging, type index_Message as Message, type index_NodeOptions as NodeOptions, type index_OnExecuteBasicTriggerOpts as OnExecuteBasicTriggerOpts, type index_PromisifiedFn as PromisifiedFn, index_PubSubHelper as PubSubHelper, index_RateLimit as RateLimit, type index_ReceivedMessage as ReceivedMessage, index_RedisConnectionError as RedisConnectionError, index_Runtime as Runtime, index_SchedulerHelper as SchedulerHelper, index_Secrets as Secrets, index_TriggerHelper as TriggerHelper, type index_TriggerOnCreateOptions as TriggerOnCreateOptions, type index_TriggerOnExecuteOptions as TriggerOnExecuteOptions, index_createHandlerDecorator as createHandlerDecorator, index_getEventTime as getEventTime, index_getFirestore as getFirestore, index_isCloudTask as isCloudTask, index_isCronMessage as isCronMessage, index_isPubSubRequest as isPubSubRequest, index_parseDateOrDefault as parseDateOrDefault, index_sanitize as sanitize, index_sanitizeToString as sanitizeToString, index_shortHash as shortHash, index_slugify as slugify, index_validate as validate, index_validateGoogleAuth as validateGoogleAuth };
+  export { index_ActionHelper as ActionHelper, type index_ActionHelperOptions as ActionHelperOptions, index_AirtableHelper as AirtableHelper, index_BigQueryHelper as BigQueryHelper, index_CloudTasksHelper as CloudTasksHelper, index_DatoHelper as DatoHelper, index_EnvEngine as EnvEngine, type index_ILogging as ILogging, index_JWKSHelper as JWKSHelper, index_Logging as Logging, type index_Message as Message, type index_NodeOptions as NodeOptions, type index_OnExecuteBasicTriggerOpts as OnExecuteBasicTriggerOpts, type index_PromisifiedFn as PromisifiedFn, index_PubSubHelper as PubSubHelper, index_RateLimit as RateLimit, type index_ReceivedMessage as ReceivedMessage, index_RedisConnectionError as RedisConnectionError, index_Runtime as Runtime, index_SchedulerHelper as SchedulerHelper, index_Secrets as Secrets, index_TriggerHelper as TriggerHelper, type index_TriggerOnCreateOptions as TriggerOnCreateOptions, type index_TriggerOnExecuteOptions as TriggerOnExecuteOptions, index_createHandlerDecorator as createHandlerDecorator, index_getAccessToken as getAccessToken, index_getEventTime as getEventTime, index_getFirestore as getFirestore, index_getSecret as getSecret, index_isCloudTask as isCloudTask, index_isCronMessage as isCronMessage, index_isPubSubRequest as isPubSubRequest, index_isRespectfulNudge as isRespectfulNudge, index_parseDateOrDefault as parseDateOrDefault, index_sanitize as sanitize, index_sanitizeToString as sanitizeToString, index_shortHash as shortHash, index_slugify as slugify, index_validate as validate, index_validateGoogleAuth as validateGoogleAuth };
 }
 
 export { index as lib, index$9 as schema, index$1 as types };