modal 0.11.1-dev.14 → 0.11.1-dev.16

package/dist/index.cjs

@@ -51,6 +51,7 @@ __export(index_exports, {
   FunctionCallLogsManager: () => FunctionCallLogsManager,
   FunctionCallService: () => FunctionCallService,
   FunctionLogsManager: () => FunctionLogsManager,
+  FunctionMetricsManager: () => FunctionMetricsManager,
   FunctionService: () => FunctionService,
   FunctionTimeoutError: () => FunctionTimeoutError,
   Function_: () => Function_,
@@ -36229,7 +36230,7 @@ var ImageListTagsItem = {
   }
 };
 function createBaseImageListTagsRequest() {
-  return { environmentName: "", tagPrefix: "", maxObjects: 0, pageToken: "" };
+  return { environmentName: "", tagPrefix: "", maxObjects: 0, pageToken: "", imageId: "" };
 }
 var ImageListTagsRequest = {
   encode(message, writer = new BinaryWriter()) {
@@ -36245,6 +36246,9 @@ var ImageListTagsRequest = {
     if (message.pageToken !== "") {
       writer.uint32(34).string(message.pageToken);
     }
+    if (message.imageId !== "") {
+      writer.uint32(42).string(message.imageId);
+    }
     return writer;
   },
   decode(input, length) {
@@ -36282,6 +36286,13 @@ var ImageListTagsRequest = {
           message.pageToken = reader.string();
           continue;
         }
+        case 5: {
+          if (tag !== 42) {
+            break;
+          }
+          message.imageId = reader.string();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -36295,7 +36306,8 @@ var ImageListTagsRequest = {
       environmentName: isSet5(object.environmentName) ? globalThis.String(object.environmentName) : "",
       tagPrefix: isSet5(object.tagPrefix) ? globalThis.String(object.tagPrefix) : "",
       maxObjects: isSet5(object.maxObjects) ? globalThis.Number(object.maxObjects) : 0,
-      pageToken: isSet5(object.pageToken) ? globalThis.String(object.pageToken) : ""
+      pageToken: isSet5(object.pageToken) ? globalThis.String(object.pageToken) : "",
+      imageId: isSet5(object.imageId) ? globalThis.String(object.imageId) : ""
     };
   },
   toJSON(message) {
@@ -36312,6 +36324,9 @@ var ImageListTagsRequest = {
     if (message.pageToken !== "") {
       obj.pageToken = message.pageToken;
     }
+    if (message.imageId !== "") {
+      obj.imageId = message.imageId;
+    }
     return obj;
   },
   create(base) {
@@ -36323,6 +36338,7 @@ var ImageListTagsRequest = {
     message.tagPrefix = object.tagPrefix ?? "";
     message.maxObjects = object.maxObjects ?? 0;
     message.pageToken = object.pageToken ?? "";
+    message.imageId = object.imageId ?? "";
     return message;
   }
 };
@@ -36616,6 +36632,57 @@ var ImageMetadata_PythonPackagesEntry = {
     return message;
   }
 };
+function createBaseImageNameDeleteRequest() {
+  return { tag: "" };
+}
+var ImageNameDeleteRequest = {
+  encode(message, writer = new BinaryWriter()) {
+    if (message.tag !== "") {
+      writer.uint32(10).string(message.tag);
+    }
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseImageNameDeleteRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+          message.tag = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(object) {
+    return { tag: isSet5(object.tag) ? globalThis.String(object.tag) : "" };
+  },
+  toJSON(message) {
+    const obj = {};
+    if (message.tag !== "") {
+      obj.tag = message.tag;
+    }
+    return obj;
+  },
+  create(base) {
+    return ImageNameDeleteRequest.fromPartial(base ?? {});
+  },
+  fromPartial(object) {
+    const message = createBaseImageNameDeleteRequest();
+    message.tag = object.tag ?? "";
+    return message;
+  }
+};
 function createBaseImagePublishRequest() {
   return { imageId: "", tag: "", environmentName: "", allowPublic: false };
 }
@@ -66434,6 +66501,14 @@ var ModalClientDefinition = {
       responseStream: false,
       options: {}
     },
+    imageNameDelete: {
+      name: "ImageNameDelete",
+      requestType: ImageNameDeleteRequest,
+      requestStream: false,
+      responseType: Empty,
+      responseStream: false,
+      options: {}
+    },
     imagePublish: {
       name: "ImagePublish",
       requestType: ImagePublishRequest,
@@ -67635,11 +67710,40 @@ var TimeoutError = class extends Error {
     this.name = "TimeoutError";
   }
 };
-var FunctionTimeoutError = class extends Error {
+var FunctionTimeoutError = class _FunctionTimeoutError extends Error {
   constructor(message) {
     super(message);
     this.name = "FunctionTimeoutError";
   }
+  // Backward compatibility: FunctionCall.get() wait timeouts still match
+  // FunctionTimeoutError, with a deprecation warning.
+  static [Symbol.hasInstance](instance) {
+    if (Function.prototype[Symbol.hasInstance].call(this, instance)) {
+      return true;
+    }
+    if (this === _FunctionTimeoutError && instance instanceof FunctionCallGetTimeoutError) {
+      instance.warnFunctionTimeoutErrorMatch();
+      return true;
+    }
+    return false;
+  }
+};
+var warnedFunctionTimeoutErrorMatch = false;
+var FunctionCallGetTimeoutError = class extends TimeoutError {
+  #logger;
+  constructor(message, logger2) {
+    super(message);
+    this.#logger = logger2;
+  }
+  warnFunctionTimeoutErrorMatch() {
+    if (warnedFunctionTimeoutErrorMatch) {
+      return;
+    }
+    warnedFunctionTimeoutErrorMatch = true;
+    this.#logger.warn(
+      "Matching a FunctionCall.get() timeout with `instanceof FunctionTimeoutError` is deprecated and will stop working in a future release; check `instanceof TimeoutError` first instead."
+    );
+  }
 };
 var RemoteError = class extends Error {
   constructor(message) {
@@ -68219,12 +68323,14 @@ async function blobDownload(cpClient, blobId) {
 var outputsTimeoutMs = 55 * 1e3;
 var ControlPlaneInvocation = class _ControlPlaneInvocation {
   cpClient;
+  logger;
   functionCallId;
   input;
   functionCallJwt;
   inputJwt;
-  constructor(cpClient, functionCallId, input, functionCallJwt, inputJwt) {
+  constructor(cpClient, logger2, functionCallId, input, functionCallJwt, inputJwt) {
     this.cpClient = cpClient;
+    this.logger = logger2;
     this.functionCallId = functionCallId;
     this.input = input;
     this.functionCallJwt = functionCallJwt;
@@ -68243,6 +68349,7 @@ var ControlPlaneInvocation = class _ControlPlaneInvocation {
     });
     return new _ControlPlaneInvocation(
       client.cpClient,
+      client.logger,
       functionMapResponse.functionCallId,
       input,
       functionMapResponse.functionCallJwt,
@@ -68250,11 +68357,16 @@ var ControlPlaneInvocation = class _ControlPlaneInvocation {
     );
   }
   static fromFunctionCallId(client, functionCallId) {
-    return new _ControlPlaneInvocation(client.cpClient, functionCallId);
+    return new _ControlPlaneInvocation(
+      client.cpClient,
+      client.logger,
+      functionCallId
+    );
   }
   async awaitOutput(timeoutMs, clearOnSuccess = false) {
     return await pollFunctionOutput(
       this.cpClient,
+      this.logger,
       (timeoutMs2) => this.#getOutput(
         timeoutMs2,
         clearOnSuccess,
@@ -68294,12 +68406,14 @@ var ControlPlaneInvocation = class _ControlPlaneInvocation {
 var InputPlaneInvocation = class _InputPlaneInvocation {
   cpClient;
   ipClient;
+  logger;
   functionId;
   input;
   attemptToken;
-  constructor(cpClient, ipClient, functionId, input, attemptToken) {
+  constructor(cpClient, ipClient, logger2, functionId, input, attemptToken) {
     this.cpClient = cpClient;
     this.ipClient = ipClient;
+    this.logger = logger2;
     this.functionId = functionId;
     this.input = input;
     this.attemptToken = attemptToken;
@@ -68317,6 +68431,7 @@ var InputPlaneInvocation = class _InputPlaneInvocation {
     return new _InputPlaneInvocation(
       client.cpClient,
       ipClient,
+      client.logger,
       functionId,
       functionPutInputsItem,
       attemptStartResponse.attemptToken
@@ -68325,6 +68440,7 @@ var InputPlaneInvocation = class _InputPlaneInvocation {
   async awaitOutput(timeoutMs) {
     return await pollFunctionOutput(
       this.cpClient,
+      this.logger,
       (timeoutMs2) => this.#getOutput(timeoutMs2),
       timeoutMs
     );
@@ -68349,7 +68465,7 @@ var InputPlaneInvocation = class _InputPlaneInvocation {
 function timeNowSeconds() {
   return Date.now() / 1e3;
 }
-async function pollFunctionOutput(cpClient, getOutput, timeoutMs) {
+async function pollFunctionOutput(cpClient, logger2, getOutput, timeoutMs) {
   const startTime = Date.now();
   let pollTimeoutMs = outputsTimeoutMs;
   if (timeoutMs !== void 0) {
@@ -68364,7 +68480,7 @@ async function pollFunctionOutput(cpClient, getOutput, timeoutMs) {
       const remainingMs = timeoutMs - (Date.now() - startTime);
       if (remainingMs <= 0) {
         const message = `Timeout exceeded: ${timeoutMs}ms`;
-        throw new FunctionTimeoutError(message);
+        throw new FunctionCallGetTimeoutError(message, logger2);
       }
       pollTimeoutMs = Math.min(outputsTimeoutMs, remainingMs);
     }
@@ -75954,6 +76070,21 @@ var import_uuid = require("uuid");
 
 // src/volume.ts
 var import_nice_grpc11 = require("nice-grpc");
+function volumeFsVersionProto(version) {
+  switch (version) {
+    case void 0:
+      return 0 /* VOLUME_FS_VERSION_UNSPECIFIED */;
+    case 1:
+      return 1 /* VOLUME_FS_VERSION_V1 */;
+    case 2:
+      return 2 /* VOLUME_FS_VERSION_V2 */;
+    default:
+      throw new InvalidError("VolumeFS version must be either 1 or 2");
+  }
+}
+function normalizeVolumeFsVersion(version) {
+  return version === 0 /* VOLUME_FS_VERSION_UNSPECIFIED */ ? 1 /* VOLUME_FS_VERSION_V1 */ : version;
+}
 var VolumeService = class {
   #client;
   constructor(client) {
@@ -75963,12 +76094,25 @@ var VolumeService = class {
    * Reference a {@link Volume} by its name.
    */
   async fromName(name, params) {
+    const requestedVersion = volumeFsVersionProto(params?.version);
     try {
       const resp = await this.#client.cpClient.volumeGetOrCreate({
         deploymentName: name,
         environmentName: this.#client.environmentName(params?.environment),
-        objectCreationType: params?.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : 0 /* OBJECT_CREATION_TYPE_UNSPECIFIED */
+        objectCreationType: params?.createIfMissing ? 1 /* OBJECT_CREATION_TYPE_CREATE_IF_MISSING */ : 0 /* OBJECT_CREATION_TYPE_UNSPECIFIED */,
+        version: requestedVersion
       });
+      if (params?.version !== void 0) {
+        const actualVersion = normalizeVolumeFsVersion(
+          resp.metadata?.version ?? 0 /* VOLUME_FS_VERSION_UNSPECIFIED */
+        );
+        const normalizedRequestedVersion = normalizeVolumeFsVersion(requestedVersion);
+        if (actualVersion !== normalizedRequestedVersion) {
+          throw new InvalidError(
+            `Volume '${name}' exists but has version v${actualVersion}, not v${normalizedRequestedVersion} as requested. To access this Volume, either omit the version parameter or use the correct version.`
+          );
+        }
+      }
       this.#client.logger.debug(
         "Retrieved Volume",
         "volume_id",
@@ -79002,7 +79146,7 @@ var AuthTokenManager = class {
 };
 
 // src/version.ts
-var SDK_VERSION = "0.11.1-dev.14";
+var SDK_VERSION = "0.11.1-dev.16";
 function getSDKVersion() {
   return SDK_VERSION;
 }
@@ -80633,7 +80777,12 @@ var FunctionCall = class {
     this.#client = client;
     this.functionCallId = functionCallId;
   }
-  /** Get the result of a FunctionCall, optionally waiting with a timeout. */
+  /**
+   * Get the result of a FunctionCall, optionally waiting with a timeout.
+   *
+   * @throws {@link TimeoutError} if `timeoutMs` elapses before the Function finishes.
+   * @throws {@link FunctionTimeoutError} if the Function exceeds its execution timeout.
+   */
   async get(params = {}) {
     checkForRenamedParams(params, { timeout: "timeoutMs" });
     const invocation = ControlPlaneInvocation.fromFunctionCallId(
@@ -80674,6 +80823,142 @@ var FunctionCall = class {
 // src/function.ts
 var import_nice_grpc17 = require("nice-grpc");
 
+// src/metrics.ts
+function metricsRequest(params) {
+  const until = params.until ?? /* @__PURE__ */ new Date();
+  const since = params.since ?? new Date(until.getTime() - 60 * 60 * 1e3);
+  if (!Number.isFinite(since.getTime()) || !Number.isFinite(until.getTime())) {
+    throw new InvalidError("`since` and `until` must be valid dates.");
+  }
+  if (since >= until) {
+    throw new InvalidError("`since` must be before `until`.");
+  }
+  if (since.getTime() < 0) {
+    throw new InvalidError("`since` must be at or after the Unix epoch.");
+  }
+  if (until.getTime() - since.getTime() > 31 * 24 * 60 * 60 * 1e3) {
+    throw new InvalidError("Metrics time range cannot exceed 31 days.");
+  }
+  if (params.groups !== void 0 && (!Array.isArray(params.groups) || params.groups.some((g) => typeof g !== "string" || !g))) {
+    throw new InvalidError(
+      "`groups` must be an array of nonempty group names."
+    );
+  }
+  const request = FunctionGetMetricsRequest.create({
+    since,
+    until,
+    groups: params.groups ?? [],
+    rollup: params.allVariants ?? false
+  });
+  if (params.bucketSizeSecs !== void 0) {
+    const seconds = params.bucketSizeSecs;
+    if (!Number.isInteger(seconds) || seconds < 60 || seconds > 2 ** 32 - 1) {
+      throw new InvalidError(
+        "`bucketSizeSecs` must be a whole number of seconds, at least one minute."
+      );
+    }
+    if (Math.floor(until.getTime() / (params.bucketSizeSecs * 1e3)) - Math.floor(since.getTime() / (params.bucketSizeSecs * 1e3)) > 500) {
+      throw new InvalidError(
+        "Metrics are limited to 500 points per series; increase `bucketSizeSecs`."
+      );
+    }
+    request.bucketSecs = seconds;
+  }
+  return request;
+}
+var FunctionMetricsManager = class {
+  #client;
+  #functionId;
+  /** @hidden */
+  constructor(client, functionId) {
+    this.#client = client;
+    this.#functionId = functionId;
+  }
+  /**
+   * Fetch metric samples, defaulting to all groups over the last hour.
+   *
+   * The maximum range is 31 days, with at most 500 points per series. Omit
+   * bucketSizeSecs to let Modal select a supported width targeting approximately
+   * 100 buckets. Bounds round down to UTC bucket boundaries: data before since
+   * may be included, and the partial bucket at until is excluded.
+   * Missing observations have value null. Use schema() to discover definitions.
+   *
+   * @example
+   * ```typescript
+   * const metrics = await fn.metrics.export({
+   *   bucketSizeSecs: 5 * 60,
+   *   groups: ["calls"],
+   * });
+   * for (const point of metrics.series["successful_calls_count"].points) {
+   *   console.log(point.time, point.value);
+   * }
+   * ```
+   */
+  async export(params = {}) {
+    const request = metricsRequest(params);
+    request.functionId = this.#functionId;
+    const response = await this.#client.cpClient.functionGetMetrics(request);
+    const series = Object.fromEntries(
+      response.series.map((item) => [
+        item.name,
+        {
+          name: item.name,
+          unit: item.unit,
+          aggregation: item.name.slice(item.name.lastIndexOf("_") + 1),
+          description: item.description,
+          points: item.points.map((point) => ({
+            time: point.timestamp ?? /* @__PURE__ */ new Date(0),
+            value: point.value ?? null
+          }))
+        }
+      ])
+    );
+    return {
+      objectId: this.#functionId,
+      since: response.since ?? /* @__PURE__ */ new Date(0),
+      until: response.until ?? /* @__PURE__ */ new Date(0),
+      bucketSizeSecs: response.bucketSecs,
+      pointCount: Object.values(series).reduce(
+        (count, item) => count + item.points.length,
+        0
+      ),
+      series
+    };
+  }
+  /**
+   * Return metric definitions keyed by group name, without fetching samples.
+   * Omit groups to return all groups. Each group's definitions include all its
+   * individual series.
+   */
+  async schema(params = {}) {
+    const window = metricsRequest(params);
+    const response = await this.#client.cpClient.metricsGetInfo(
+      MetricsGetInfoRequest.create({
+        targetType: 1 /* METRICS_TARGET_TYPE_FUNCTION */,
+        since: window.since,
+        until: window.until,
+        groups: window.groups
+      })
+    );
+    const groups = /* @__PURE__ */ new Map();
+    for (const row of response.groups) {
+      let group = groups.get(row.name);
+      if (!group) {
+        group = { name: row.name, definitions: [] };
+        groups.set(row.name, group);
+      }
+      group.definitions.push(
+        ...row.metrics.map((metric) => ({
+          name: metric.name,
+          unit: metric.unit,
+          description: metric.description
+        }))
+      );
+    }
+    return Object.fromEntries(groups);
+  }
+};
+
 // src/retries.ts
 var Retries = class {
   maxRetries;
@@ -81056,6 +81341,10 @@ var Function_ = class _Function_ {
       this.#handleMetadata?.appId ?? ""
     );
   }
+  /** Access metric samples with export() and series definitions with schema(). */
+  get metrics() {
+    return new FunctionMetricsManager(this.#client, this.functionId);
+  }
   /** Override the static Function configuration at runtime. */
   withOptions(options) {
     return new _Function_(
@@ -81621,6 +81910,7 @@ var ExperimentalOutboundPolicy2 = class _ExperimentalOutboundPolicy {
   FunctionCallLogsManager,
   FunctionCallService,
   FunctionLogsManager,
+  FunctionMetricsManager,
   FunctionService,
   FunctionTimeoutError,
   Function_,