@friggframework/core 2.0.0--canary.658.93c8e07.0 → 2.0.0--canary.658.164d92b.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@friggframework/core",
     "prettier": "@friggframework/prettier-config",
-    "version": "2.0.0--canary.658.93c8e07.0",
+    "version": "2.0.0--canary.658.164d92b.0",
     "dependencies": {
         "@aws-sdk/client-apigatewaymanagementapi": "^3.588.0",
         "@aws-sdk/client-kms": "^3.588.0",
@@ -47,9 +47,9 @@
         }
     },
     "devDependencies": {
-        "@friggframework/eslint-config": "2.0.0--canary.658.93c8e07.0",
-        "@friggframework/prettier-config": "2.0.0--canary.658.93c8e07.0",
-        "@friggframework/test": "2.0.0--canary.658.93c8e07.0",
+        "@friggframework/eslint-config": "2.0.0--canary.658.164d92b.0",
+        "@friggframework/prettier-config": "2.0.0--canary.658.164d92b.0",
+        "@friggframework/test": "2.0.0--canary.658.164d92b.0",
         "@prisma/client": "^6.19.3",
         "@types/lodash": "4.17.15",
         "@typescript-eslint/eslint-plugin": "^8.0.0",
@@ -89,5 +89,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "93c8e078d4ff1bf00ed831152712b442abe615cd"
+    "gitHead": "164d92b13ea5ffc31d5f7861fbb936fc28ad3d97"
 }

package/types/core/index.d.ts

@@ -58,22 +58,13 @@ declare module "@friggframework/core" {
 
   export function loadInstalledModules(): any[];
 
-  /**
-   * Runs `fn` with the time the invocation ends, as epoch milliseconds. A
-   * nested scope can shorten the deadline and never extend it.
-   */
   export function runWithInvocationDeadline<T>(
     deadlineAt: number | undefined,
     fn: () => T
   ): T;
 
-  /** Milliseconds left in the invocation. `Infinity` outside a Lambda. */
   export function remainingInvocationMs(now?: number): number;
 
-  /**
-   * Finds the hint of a throttled response: the module's classify(), then the
-   * header parsers, then the static policy. Null when there is none.
-   */
   export function classifyRateLimit(
     policy: RateLimitPolicy | undefined,
     signal: RateLimitSignal,

package/types/errors/index.d.ts

@@ -16,10 +16,6 @@ declare module "@friggframework/errors" {
     readonly body: any;
     isTimeout?: boolean;
     timeoutMs?: number;
-    /**
-     * True when `classify` named the response as a limit but gave no time. A
-     * `RateLimitError` always has it.
-     */
     isRateLimited?: boolean;
     reason?: RateLimitReason;
 
@@ -35,29 +31,19 @@ declare module "@friggframework/errors" {
 
   export type RateLimitSource = "header" | "body" | "static" | "backoff";
 
-  /** What Frigg knows about when calls are accepted again. */
   export type RateLimitHint = {
-    /** When calls are accepted again. */
     retryAt: Date;
-    /** Milliseconds from the time the hint was read until `retryAt`. */
     waitMs: number;
     reason: RateLimitReason;
-    /** A provider policy name, when the response names one. */
     policy?: string;
-    /** Calls left in the window, when the response says. */
     remaining?: number;
     source: RateLimitSource;
   };
 
-  /**
-   * A FetchError for a response that said a limit was hit, and for which the
-   * response or the module's policy says when to call again.
-   */
   export class RateLimitError extends FetchError {
     constructor(options?: RateLimitErrorConstructor);
 
     isRateLimited: true;
-    /** When calls are accepted again. */
     retryAt: Date;
     waitMs: number;
     reason: RateLimitReason;
@@ -73,7 +59,6 @@ declare module "@friggframework/errors" {
 
   type RateLimitErrorConstructor = FetchErrorConstructor & {
     hint?: Partial<RateLimitHint>;
-    /** Wait from `now`. When absent, `hint.retryAt` sets the time. */
     waitMs?: number;
     module?: string;
     scopeKey?: string;

package/types/integrations/index.d.ts

@@ -5,11 +5,6 @@ declare module "@friggframework/integrations" {
     | { type: "RETRY_WHEN_READY" }
     | { type: "LINK"; label: string; url: string };
 
-  /**
-   * A stored message. The framework stores the keys of an item as given, so a
-   * caller can add its own. A rate limit adds `code: "RATE_LIMITED"`,
-   * `module`, `reason`, `retryAt` (ISO 8601) and `actions`.
-   */
   export interface IntegrationMessage {
     title: string;
     message: string;

package/types/module-plugin/index.d.ts

@@ -44,21 +44,12 @@ declare module "@friggframework/module-plugin" {
   };
 
   export type RateLimitPolicy = {
-    /** The key a limit counts against. Default `entity`. */
     scope?: RateLimitScope;
     windows?: RateLimitWindow[];
     maxConcurrency?: number;
-    /** A wait never shorter than this, for every throttled response. */
     minRetryAfterMs?: number;
-    /** The most a request sleeps in process, in total. Default 300000. */
     maxInProcessWaitMs?: number;
-    /** Header parsers, in order. Default all three. */
     parsers?: Array<"retryAfter" | "resetHeaders" | "ietf">;
-    /**
-     * Recognises a limit that is not a plain 429, or names its reason. Returns
-     * null when the response is not a limit. A hint with no time takes its
-     * time from the parsers or the policy.
-     */
     classify?(
       signal: RateLimitSignal
     ): Partial<Omit<RateLimitHint, "source">> & {
@@ -75,7 +66,6 @@ declare module "@friggframework/module-plugin" {
     static requestTimeoutMs?: number;
 
     DLGT_INVALID_AUTH: string;
-    /** Notified with the `RateLimitError` right before a wait that is too long throws. */
     DLGT_RATE_LIMITED: string;
     requestTimeoutMs: number;
     backOff: number[];
@@ -96,11 +86,6 @@ declare module "@friggframework/module-plugin" {
     parseBody(response: any): Promise<any>;
     refreshAuth(): Promise<any>;
     _adoptNewerCredential(): Promise<boolean>;
-    /**
-     * Tells the integration about a `RateLimitError` the module throws itself.
-     * The Requester calls it for its own errors; a module built on a vendor SDK
-     * calls it before its own throw.
-     */
     _notifyRateLimited(rateLimitError: RateLimitError): Promise<void>;
 
     delegate: any;
@@ -149,6 +134,7 @@ declare module "@friggframework/module-plugin" {
   type RequesterConstructor = {
     backOff?: number[];
     fetch?: any;
+    random?: () => number;
   };
 
   export class ApiKeyRequester