@visulima/storage 1.0.0-alpha.15 → 1.0.0-alpha.17

package/dist/index.d.ts

@@ -1,17 +1,376 @@
-export { waitForStorage } from "./handler/utils/storage-utils.d.ts";
-export { NoOpMetrics, OpenTelemetryMetrics } from "./metrics/index.d.ts";
-export { default as DiskStorage } from "./storage/local/disk-storage.d.ts";
-export { default as DiskStorageWithChecksum } from "./storage/local/disk-storage-with-checksum.d.ts";
-export type { LocalMetaStorageOptions } from "./storage/local/local-meta-storage.d.ts";
-export { default as LocalMetaStorage } from "./storage/local/local-meta-storage.d.ts";
-export { default as MetaStorage } from "./storage/meta-storage.d.ts";
-export { BaseStorage as AbstractBaseStorage, defaultCloudStorageFileNameValidation, defaultFilesystemFileNameValidation } from "./storage/storage.d.ts";
-export type { BaseStorageOptions, BatchOperationResponse, BatchOperationResult, DiskStorageOptions, DiskStorageWithChecksumOptions, ExpirationOptions, MetaStorageOptions, OnComplete, OnCreate, OnDelete, OnError, OnUpdate, PurgeList, } from "./storage/types.d.ts";
-export type { FileInit, FilePart, FileQuery, UploadEventType, UploadFile } from "./storage/utils/file/index.d.ts";
-export { File, Metadata } from "./storage/utils/file/index.d.ts";
-export { ErrorMap, ERRORS, isUploadError, throwErrorCode, UploadError } from "./utils/errors.d.ts";
-export type { RetryConfig } from "./utils/retry.d.ts";
-export { createRetryWrapper, isRetryableError, retry } from "./utils/retry.d.ts";
-export type { Header, Headers, HttpError, HttpErrorBody, IncomingMessageWithBody, Metrics, RangeChecksum, RangeHasher, ResponseBody, ResponseBodyType, ResponseTuple, UploadResponse, Validation, ValidationError, ValidatorConfig, } from "./utils/types.d.ts";
-export type { AnyWebReadableByteStreamWithFileType, AnyWebReadableStream, Detector, FileTypeOptions, FileTypeParser, FileTypeResult, StreamOptions, TokenizerPositionError, } from "file-type";
-export { fileTypeFromBlob, fileTypeFromBuffer, fileTypeFromTokenizer, supportedExtensions, supportedMimeTypes } from "file-type";
+import { n as Metrics } from "./packem_shared/storage.d-BOMUJD96.js";
+export { B as AbstractBaseStorage, type k as BaseStorageOptions, type o as BatchOperationResponse, type p as BatchOperationResult, type D as DiskStorageOptions, type h as DiskStorageWithChecksumOptions, E as ERRORS, q as ErrorMap, type r as ExpirationOptions, F as File, type b as FileInit, type d as FilePart, type e as FileQuery, type s as Header, type t as Headers, type H as HttpError, type u as HttpErrorBody, type I as IncomingMessageWithBody, type L as LocalMetaStorageOptions, M as MetaStorage, type m as MetaStorageOptions, v as Metadata, type O as OnComplete, type w as OnCreate, type x as OnDelete, type y as OnError, type z as OnUpdate, type P as PurgeList, type A as RangeChecksum, type G as RangeHasher, type J as ResponseBody, type i as ResponseBodyType, type K as ResponseTuple, type R as RetryConfig, f as UploadError, type g as UploadEventType, type U as UploadFile, type l as UploadResponse, type V as Validation, type N as ValidationError, type Q as ValidatorConfig, c as createRetryWrapper, S as defaultCloudStorageFileNameValidation, T as defaultFilesystemFileNameValidation, W as isRetryableError, X as isUploadError, Y as retry, Z as throwErrorCode } from "./packem_shared/storage.d-BOMUJD96.js";
+export { D as DiskStorage, a as DiskStorageWithChecksum } from "./packem_shared/disk-storage-with-checksum.d-hEoe2ugb.js";
+export { L as LocalMetaStorage } from "./packem_shared/local-meta-storage.d-Dop9RP9k.js";
+export { type AnyWebReadableByteStreamWithFileType, type AnyWebReadableStream, type Detector, type FileTypeOptions, type FileTypeParser, type FileTypeResult, type StreamOptions, type TokenizerPositionError, fileTypeFromBlob, fileTypeFromBuffer, fileTypeFromTokenizer, supportedExtensions, supportedMimeTypes } from 'file-type';
+import 'node:stream';
+import 'node:crypto';
+import 'node:http';
+import 'lru-cache';
+/**
+* Wait for storage to be ready before handling requests.
+* This ensures storage initialization (e.g., AWS S3, GCS) completes before processing uploads.
+* @param storage Storage instance with isReady property
+* @param timeoutMs Maximum time to wait in milliseconds (default: 5000)
+* @throws Error if storage doesn't become ready within timeout
+*/
+declare const waitForStorage: (storage: {
+  isReady: boolean;
+}, timeoutMs?: number) => Promise<void>;
+/**
+* No-op metrics that does nothing.
+* Used as a default when metrics are not provided.
+*/
+declare class NoOpMetrics implements Metrics {
+  increment(_name: string, _value?: number, _attributes?: Record<string, string | number>): void;
+  timing(_name: string, _duration: number, _attributes?: Record<string, string | number>): void;
+  gauge(_name: string, _value: number, _attributes?: Record<string, string | number>): void;
+}
+/**
+ * @since 1.0.0
+ */
+interface Context {
+  /**
+   * Get a value from the context.
+   *
+   * @param key key which identifies a context value
+   */
+  getValue(key: symbol): unknown;
+  /**
+   * Create a new context which inherits from this context and has
+   * the given key set to the given value.
+   *
+   * @param key context key for which to set the value
+   * @param value value to set for the given key
+   */
+  setValue(key: symbol, value: unknown): Context;
+  /**
+   * Return a new context which inherits from this context but does
+   * not contain a value for the given key.
+   *
+   * @param key context key for which to clear a value
+   */
+  deleteValue(key: symbol): Context;
+}
+/**
+ * Attributes is a map from string to attribute values.
+ *
+ * Note: only the own enumerable keys are counted as valid attribute keys.
+ *
+ * @since 1.3.0
+ */
+interface Attributes {
+  [attributeKey: string]: AttributeValue | undefined;
+}
+/**
+ * Attribute values may be any non-nullish primitive value except an object.
+ *
+ * null or undefined attribute values are invalid and will result in undefined behavior.
+ *
+ * @since 1.3.0
+ */
+type AttributeValue = string | number | boolean | Array<null | undefined | string> | Array<null | undefined | number> | Array<null | undefined | boolean>;
+/**
+ * Advisory options influencing aggregation configuration parameters.
+ *
+ * @since 1.7.0
+ * @experimental
+ */
+interface MetricAdvice {
+  /**
+   * Hint the explicit bucket boundaries for SDK if the metric is been
+   * aggregated with a HistogramAggregator.
+   */
+  explicitBucketBoundaries?: number[];
+}
+/**
+ * Options needed for metric creation
+ *
+ * @since 1.3.0
+ */
+interface MetricOptions {
+  /**
+   * The description of the Metric.
+   * @default ''
+   */
+  description?: string;
+  /**
+   * The unit of the Metric values.
+   * @default ''
+   */
+  unit?: string;
+  /**
+   * Indicates the type of the recorded value.
+   * @default {@link ValueType.DOUBLE}
+   */
+  valueType?: ValueType;
+  /**
+   * The advice influencing aggregation configuration parameters.
+   * @experimental
+   * @since 1.7.0
+   */
+  advice?: MetricAdvice;
+}
+/**
+ * The Type of value. It describes how the data is reported.
+ *
+ * @since 1.3.0
+ */
+declare enum ValueType {
+  INT = 0,
+  DOUBLE = 1,
+}
+/**
+ * Counter is the most common synchronous instrument. This instrument supports
+ * an `Add(increment)` function for reporting a sum, and is restricted to
+ * non-negative increments. The default aggregation is Sum, as for any additive
+ * instrument.
+ *
+ * Example uses for Counter:
+ * <ol>
+ *   <li> count the number of bytes received. </li>
+ *   <li> count the number of requests completed. </li>
+ *   <li> count the number of accounts created. </li>
+ *   <li> count the number of checkpoints run. </li>
+ *   <li> count the number of 5xx errors. </li>
+ * <ol>
+ *
+ * @since 1.3.0
+ */
+interface Counter<AttributesTypes extends MetricAttributes = MetricAttributes> {
+  /**
+   * Increment value of counter by the input. Inputs must not be negative.
+   */
+  add(value: number, attributes?: AttributesTypes, context?: Context): void;
+}
+/**
+ * @since 1.3.0
+ */
+interface UpDownCounter<AttributesTypes extends MetricAttributes = MetricAttributes> {
+  /**
+   * Increment value of counter by the input. Inputs may be negative.
+   */
+  add(value: number, attributes?: AttributesTypes, context?: Context): void;
+}
+/**
+ * @since 1.9.0
+ */
+interface Gauge<AttributesTypes extends MetricAttributes = MetricAttributes> {
+  /**
+   * Records a measurement.
+   */
+  record(value: number, attributes?: AttributesTypes, context?: Context): void;
+}
+/**
+ * @since 1.3.0
+ */
+interface Histogram<AttributesTypes extends MetricAttributes = MetricAttributes> {
+  /**
+   * Records a measurement. Value of the measurement must not be negative.
+   */
+  record(value: number, attributes?: AttributesTypes, context?: Context): void;
+}
+/**
+ * @deprecated please use {@link Attributes}
+ * @since 1.3.0
+ */
+type MetricAttributes = Attributes;
+/**
+ * Interface that is being used in callback function for Observable Metric.
+ *
+ * @since 1.3.0
+ */
+interface ObservableResult<AttributesTypes extends MetricAttributes = MetricAttributes> {
+  /**
+   * Observe a measurement of the value associated with the given attributes.
+   *
+   * @param value The value to be observed.
+   * @param attributes The attributes associated with the value. If more than
+   * one value is associated with the same attributes values, SDK may pick the
+   * last one or simply drop the entire observable result.
+   */
+  observe(this: ObservableResult<AttributesTypes>, value: number, attributes?: AttributesTypes): void;
+}
+/**
+ * Interface that is being used in batch observable callback function.
+ */
+interface BatchObservableResult<AttributesTypes extends MetricAttributes = MetricAttributes> {
+  /**
+   * Observe a measurement of the value associated with the given attributes.
+   *
+   * @param metric The observable metric to be observed.
+   * @param value The value to be observed.
+   * @param attributes The attributes associated with the value. If more than
+   * one value is associated with the same attributes values, SDK may pick the
+   * last one or simply drop the entire observable result.
+   */
+  observe(this: BatchObservableResult<AttributesTypes>, metric: Observable<AttributesTypes>, value: number, attributes?: AttributesTypes): void;
+}
+/**
+ * The observable callback for Observable instruments.
+ *
+ * @since 1.3.0
+ */
+type ObservableCallback<AttributesTypes extends MetricAttributes = MetricAttributes> = (observableResult: ObservableResult<AttributesTypes>) => void | Promise<void>;
+/**
+ * The observable callback for a batch of Observable instruments.
+ *
+ * @since 1.3.0
+ */
+type BatchObservableCallback<AttributesTypes extends MetricAttributes = MetricAttributes> = (observableResult: BatchObservableResult<AttributesTypes>) => void | Promise<void>;
+/**
+ * @since 1.3.0
+ */
+interface Observable<AttributesTypes extends MetricAttributes = MetricAttributes> {
+  /**
+   * Sets up a function that will be called whenever a metric collection is initiated.
+   *
+   * If the function is already in the list of callbacks for this Observable, the function is not added a second time.
+   */
+  addCallback(callback: ObservableCallback<AttributesTypes>): void;
+  /**
+   * Removes a callback previously registered with {@link Observable.addCallback}.
+   */
+  removeCallback(callback: ObservableCallback<AttributesTypes>): void;
+}
+/**
+ * @since 1.3.0
+ */
+type ObservableCounter<AttributesTypes extends MetricAttributes = MetricAttributes> = Observable<AttributesTypes>;
+/**
+ * @since 1.3.0
+ */
+type ObservableUpDownCounter<AttributesTypes extends MetricAttributes = MetricAttributes> = Observable<AttributesTypes>;
+/**
+ * @since 1.3.0
+ */
+type ObservableGauge<AttributesTypes extends MetricAttributes = MetricAttributes> = Observable<AttributesTypes>;
+/**
+ * An interface to allow the recording metrics.
+ *
+ * {@link Metric}s are used for recording pre-defined aggregation (`Counter`),
+ * or raw values (`Histogram`) in which the aggregation and attributes
+ * for the exported metric are deferred.
+ *
+ * @since 1.3.0
+ */
+interface Meter {
+  /**
+   * Creates and returns a new `Gauge`.
+   * @param name the name of the metric.
+   * @param [options] the metric options.
+   */
+  createGauge<AttributesTypes extends MetricAttributes = MetricAttributes>(name: string, options?: MetricOptions): Gauge<AttributesTypes>;
+  /**
+   * Creates and returns a new `Histogram`.
+   * @param name the name of the metric.
+   * @param [options] the metric options.
+   */
+  createHistogram<AttributesTypes extends MetricAttributes = MetricAttributes>(name: string, options?: MetricOptions): Histogram<AttributesTypes>;
+  /**
+   * Creates a new `Counter` metric. Generally, this kind of metric when the
+   * value is a quantity, the sum is of primary interest, and the event count
+   * and value distribution are not of primary interest.
+   * @param name the name of the metric.
+   * @param [options] the metric options.
+   */
+  createCounter<AttributesTypes extends MetricAttributes = MetricAttributes>(name: string, options?: MetricOptions): Counter<AttributesTypes>;
+  /**
+   * Creates a new `UpDownCounter` metric. UpDownCounter is a synchronous
+   * instrument and very similar to Counter except that Add(increment)
+   * supports negative increments. It is generally useful for capturing changes
+   * in an amount of resources used, or any quantity that rises and falls
+   * during a request.
+   * Example uses for UpDownCounter:
+   * <ol>
+   *   <li> count the number of active requests. </li>
+   *   <li> count memory in use by instrumenting new and delete. </li>
+   *   <li> count queue size by instrumenting enqueue and dequeue. </li>
+   *   <li> count semaphore up and down operations. </li>
+   * </ol>
+   *
+   * @param name the name of the metric.
+   * @param [options] the metric options.
+   */
+  createUpDownCounter<AttributesTypes extends MetricAttributes = MetricAttributes>(name: string, options?: MetricOptions): UpDownCounter<AttributesTypes>;
+  /**
+   * Creates a new `ObservableGauge` metric.
+   *
+   * The callback SHOULD be safe to be invoked concurrently.
+   *
+   * @param name the name of the metric.
+   * @param [options] the metric options.
+   */
+  createObservableGauge<AttributesTypes extends MetricAttributes = MetricAttributes>(name: string, options?: MetricOptions): ObservableGauge<AttributesTypes>;
+  /**
+   * Creates a new `ObservableCounter` metric.
+   *
+   * The callback SHOULD be safe to be invoked concurrently.
+   *
+   * @param name the name of the metric.
+   * @param [options] the metric options.
+   */
+  createObservableCounter<AttributesTypes extends MetricAttributes = MetricAttributes>(name: string, options?: MetricOptions): ObservableCounter<AttributesTypes>;
+  /**
+   * Creates a new `ObservableUpDownCounter` metric.
+   *
+   * The callback SHOULD be safe to be invoked concurrently.
+   *
+   * @param name the name of the metric.
+   * @param [options] the metric options.
+   */
+  createObservableUpDownCounter<AttributesTypes extends MetricAttributes = MetricAttributes>(name: string, options?: MetricOptions): ObservableUpDownCounter<AttributesTypes>;
+  /**
+   * Sets up a function that will be called whenever a metric collection is
+   * initiated.
+   *
+   * If the function is already in the list of callbacks for this Observable,
+   * the function is not added a second time.
+   *
+   * Only the associated observables can be observed in the callback.
+   * Measurements of observables that are not associated observed in the
+   * callback are dropped.
+   *
+   * @param callback the batch observable callback
+   * @param observables the observables associated with this batch observable callback
+   */
+  addBatchObservableCallback<AttributesTypes extends MetricAttributes = MetricAttributes>(callback: BatchObservableCallback<AttributesTypes>, observables: Observable<AttributesTypes>[]): void;
+  /**
+   * Removes a callback previously registered with {@link Meter.addBatchObservableCallback}.
+   *
+   * The callback to be removed is identified using a combination of the callback itself,
+   * and the set of the observables associated with it.
+   *
+   * @param callback the batch observable callback
+   * @param observables the observables associated with this batch observable callback
+   */
+  removeBatchObservableCallback<AttributesTypes extends MetricAttributes = MetricAttributes>(callback: BatchObservableCallback<AttributesTypes>, observables: Observable<AttributesTypes>[]): void;
+}
+/**
+* OpenTelemetry-based metrics implementation.
+*/
+declare class OpenTelemetryMetrics implements Metrics {
+  private readonly meter;
+  private readonly counters;
+  private readonly histograms;
+  private readonly gauges;
+  /**
+  * Creates a new OpenTelemetryMetrics instance.
+  * @param meter OpenTelemetry Meter instance. If not provided, uses the default meter.
+  * @throws {Error} If \@opentelemetry/api is not installed
+  */
+  constructor(meter?: Meter);
+  /**
+  * Increment a counter metric.
+  */
+  increment(name: string, value?: number, attributes?: Record<string, string | number>): void;
+  /**
+  * Record a duration/timing metric in milliseconds.
+  */
+  timing(name: string, duration: number, attributes?: Record<string, string | number>): void;
+  /**
+  * Set a gauge metric value.
+  */
+  gauge(name: string, value: number, attributes?: Record<string, string | number>): void;
+}
+export { type Metrics, NoOpMetrics, OpenTelemetryMetrics, waitForStorage };

package/dist/openapi/index.d.ts

@@ -1,5 +1,24 @@
-export { default as restOpenApiSpec } from "./rest.d.ts";
-export { sharedErrorSchemaObject, sharedFileMetaExampleObject, sharedFileMetaSchemaObject, sharedGet, sharedGetList } from "./shared.d.ts";
-export { default as transformOpenApiSpec } from "./transform.d.ts";
-export { default as tusOpenApiSpec } from "./tus.d.ts";
-export { default as xhrOpenApiSpec } from "./xhr.d.ts";
+import { OpenAPIV3 } from 'openapi-types';
+declare const swaggerSpec$3: (origin: string, path: string, options: {
+  supportedTransformerFormat?: string[];
+  tags?: string[] | undefined;
+  transformer?: boolean | "audio" | "video" | "image";
+}) => Partial<OpenAPIV3.Document>;
+type TransformType = boolean | "audio" | "video" | "image";
+declare const sharedGet: (operationId: string, tags: string[] | undefined, transform?: TransformType, transformerFormat?: string[]) => OpenAPIV3.OperationObject;
+declare const sharedErrorSchemaObject: Record<string, OpenAPIV3.NonArraySchemaObject>;
+declare const sharedFileMetaSchemaObject: Record<string, OpenAPIV3.NonArraySchemaObject>;
+declare const sharedFileMetaExampleObject: Record<string, OpenAPIV3.ExampleObject>;
+declare const sharedGetList: (operationId: string, tags: string[] | undefined) => OpenAPIV3.OperationObject;
+declare const swaggerSpec$2: (path?: string, tags?: string[] | undefined) => Partial<OpenAPIV3.Document>;
+declare const swaggerSpec$1: (path: string, options: {
+  supportedTransformerFormat?: string[];
+  tags?: string[] | undefined;
+  transformer?: boolean | "audio" | "video" | "image";
+}) => Partial<OpenAPIV3.Document>;
+declare const swaggerSpec: (origin: string, path: string, options: {
+  supportedTransformerFormat?: string[];
+  tags?: string[] | undefined;
+  transformer?: boolean | "audio" | "video" | "image";
+}) => Partial<OpenAPIV3.Document>;
+export { swaggerSpec$3 as restOpenApiSpec, sharedErrorSchemaObject, sharedFileMetaExampleObject, sharedFileMetaSchemaObject, sharedGet, sharedGetList, swaggerSpec$2 as transformOpenApiSpec, swaggerSpec$1 as tusOpenApiSpec, swaggerSpec as xhrOpenApiSpec };

package/dist/packem_shared/{GCSMetaStorage-BkUIdJ5m.js → GCSMetaStorage-BygVH0Ee.js}

@@ -1,7 +1,7 @@
 import 'node:crypto';
 import 'gaxios';
 import 'google-auth-library';
-export { G as default } from './gcs-meta-storage-DBeGn2ix.js';
+export { G as default } from './gcs-meta-storage-8FovEDbW.js';
 import './MetaStorage-pECeFOad.js';
 import './Metadata-DRLXeJ0F.js';
 import './GCSConfig-vPP22kN6.js';

package/dist/packem_shared/{GCStorage-BnsSAjdW.js → GCStorage-4hSx_bN1.js}

@@ -1,7 +1,7 @@
 import { randomUUID } from 'node:crypto';
 import { request } from 'gaxios';
 import { GoogleAuth } from 'google-auth-library';
-import { r as retryOptions, G as GCSMetaStorage, g as getRangeEnd, p as package_, b as buildContentRange } from './gcs-meta-storage-DBeGn2ix.js';
+import { r as retryOptions, G as GCSMetaStorage, g as getRangeEnd, p as package_, b as buildContentRange } from './gcs-meta-storage-8FovEDbW.js';
 import { p as partMatch, d as detectFileTypeFromStream, g as getFileStatus } from './part-match-Dt738Ddb.js';
 import { throwErrorCode, ERRORS } from './ERRORS-D0apMqnc.js';
 import { B as BaseStorage, t as toMilliseconds } from './storage-5XW1E7XU.js';