@nestm/storage 0.1.0-alpha.7 → 0.1.0-alpha.8

package/dist/testing/provider-conformance.d.ts

@@ -0,0 +1,65 @@
+import type { StorageClient } from '../storage.client.js';
+import type { StorageConditionalCopyDestinationCapability, StorageConditionalCopySourceCapability, StorageConditionalDeleteCapability, StorageConditionalMultipartCompletionCapability, StorageConditionalReadCapability, StorageConditionalWriteCapability, StoragePhysicalKeyCapability, StorageSignedUploadPolicyCapability } from '../storage.types.js';
+declare const PASSED: Readonly<{
+    status: 'passed';
+}>;
+export interface StorageProviderConformanceCapabilities {
+    readonly conditionalCreate?: StorageConditionalWriteCapability;
+    readonly conditionalReplace?: StorageConditionalWriteCapability;
+    readonly conditionalDelete?: StorageConditionalDeleteCapability;
+    readonly conditionalRead?: StorageConditionalReadCapability;
+    readonly conditionalCopySource?: StorageConditionalCopySourceCapability;
+    readonly conditionalCopyDestination?: StorageConditionalCopyDestinationCapability;
+    readonly conditionalMultipartCompletion?: StorageConditionalMultipartCompletionCapability;
+    readonly physicalKey: StoragePhysicalKeyCapability;
+    readonly signedUploadPolicy?: StorageSignedUploadPolicyCapability;
+}
+export interface StorageProviderConformanceFixture {
+    readonly client: StorageClient;
+    /**
+     * Builds a new client and driver for the same logical store and backend
+     * configuration. The harness owns the returned client and shuts it down.
+     */
+    readonly createReplica: () => StorageClient | Promise<StorageClient>;
+    /**
+     * Returns the number of operations dispatched to the provider driver. When
+     * supplied, the contract proves invalid inputs fail before provider I/O.
+     */
+    readonly dispatchCount?: () => number;
+    /**
+     * Resolves the current immutable version for a logical key. Providers that
+     * advertise version predicates should supply this for a version-enabled
+     * test bucket. Returning undefined visibly skips only the version subcases.
+     */
+    readonly resolveVersion?: (key: string) => Promise<string | undefined>;
+    /**
+     * Optional provider-aware cleanup. This is useful for versioned buckets,
+     * where a plain delete would leave historical object versions behind.
+     */
+    readonly cleanup?: (keys: readonly string[]) => void | Promise<void>;
+    readonly close?: () => void | Promise<void>;
+}
+export interface StorageProviderConformanceOptions {
+    readonly createFixture: (() => StorageProviderConformanceFixture) | (() => Promise<StorageProviderConformanceFixture>);
+    readonly expected: StorageProviderConformanceCapabilities;
+    /** Values such as test credentials that must never occur in public errors. */
+    readonly forbiddenErrorValues?: readonly string[];
+    readonly multipartBytes?: number;
+    readonly provider: string;
+}
+export type StorageProviderConformanceCaseResult = typeof PASSED | {
+    readonly reason: string;
+    readonly status: 'skipped';
+};
+export interface StorageProviderConformanceCase {
+    readonly name: string;
+    run(): Promise<StorageProviderConformanceCaseResult>;
+}
+/**
+ * Builds runner-agnostic provider contract cases. A test runner can register
+ * each returned case independently and translate a `skipped` result into its
+ * native skip primitive. Every case receives a fresh client and namespace.
+ */
+export declare function createStorageProviderConformanceCases(options: StorageProviderConformanceOptions): readonly StorageProviderConformanceCase[];
+export {};
+//# sourceMappingURL=provider-conformance.d.ts.map

package/dist/testing/provider-conformance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider-conformance.d.ts","sourceRoot":"","sources":["../../src/testing/provider-conformance.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAO1D,OAAO,KAAK,EAEV,2CAA2C,EAC3C,sCAAsC,EACtC,kCAAkC,EAClC,+CAA+C,EAC/C,gCAAgC,EAChC,iCAAiC,EAGjC,4BAA4B,EAC5B,mCAAmC,EAEpC,MAAM,qBAAqB,CAAC;AAY7B,QAAA,MAAM,MAAM;YAA2B,QAAQ;EAAY,CAAC;AAE5D,MAAM,WAAW,sCAAsC;IACrD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iCAAiC,CAAC;IAC/D,QAAQ,CAAC,kBAAkB,CAAC,EAAE,iCAAiC,CAAC;IAChE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,kCAAkC,CAAC;IAChE,QAAQ,CAAC,eAAe,CAAC,EAAE,gCAAgC,CAAC;IAC5D,QAAQ,CAAC,qBAAqB,CAAC,EAAE,sCAAsC,CAAC;IACxE,QAAQ,CAAC,0BAA0B,CAAC,EAAE,2CAA2C,CAAC;IAClF,QAAQ,CAAC,8BAA8B,CAAC,EAAE,+CAA+C,CAAC;IAC1F,QAAQ,CAAC,WAAW,EAAE,4BAA4B,CAAC;IACnD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,mCAAmC,CAAC;CACnE;AAED,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrE;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,MAAM,CAAC;IACtC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACvE;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,aAAa,EAClB,CAAC,MAAM,iCAAiC,CAAC,GACzC,CAAC,MAAM,OAAO,CAAC,iCAAiC,CAAC,CAAC,CAAC;IACvD,QAAQ,CAAC,QAAQ,EAAE,sCAAsC,CAAC;IAC1D,8EAA8E;IAC9E,QAAQ,CAAC,oBAAoB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClD,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,oCAAoC,GAC9C,OAAO,MAAM,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC;AAE1E,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,GAAG,IAAI,OAAO,CAAC,oCAAoC,CAAC,CAAC;CACtD;AAkBD;;;;GAIG;AACH,wBAAgB,qCAAqC,CACnD,OAAO,EAAE,iCAAiC,GACzC,SAAS,8BAA8B,EAAE,CA8E3C"}