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

package/dist/artifacts/storage-driver.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"storage-driver.d.ts","sourceRoot":"","sources":["../../src/artifacts/storage-driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAIL,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACzB,MAAM,gCAAgC,CAAC;AAIxC,eAAO,MAAM,4BAA4B,cAAc,CAAC;AACxD,eAAO,MAAM,0BAA0B,YAAY,CAAC;AACpD,eAAO,MAAM,yBAAyB,YAAI,UAAU,EAAE,WAAW,CAAU,CAAC;AAE5E;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,aAAa,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,wFAAwF;IACxF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC;IAC/B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,8FAA8F;AAC9F,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAMD,2FAA2F;AAC3F,wBAAgB,uBAAuB,CACrC,UAAU,GAAE,SAAS,MAAM,EAA8B,GACxD,WAAW,CAAC,MAAM,CAAC,CAyBrB;AAUD,wFAAwF;AACxF,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAU3E;AAmBD,wBAAgB,2BAA2B,CACzC,GAAG,EAAE,qBAAqB,GACzB,OAAO,CAAC,aAAa,CAAC,CAExB;AAED,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,qBAAqB,GACzB,OAAO,CAAC,aAAa,CAAC,CAKxB;AAED,wBAAsB,2BAA2B,CAC/C,GAAG,EAAE,qBAAqB,GACzB,OAAO,CAAC,aAAa,CAAC,CAKxB;AAED,wBAAsB,yBAAyB,CAC7C,GAAG,EAAE,qBAAqB,GACzB,OAAO,CAAC,aAAa,CAAC,CAKxB"}

package/dist/artifacts/storage-driver.js

@@ -1,89 +0,0 @@
-import { StorageClient } from '../core/index.js';
-import { createProviderStorageDriver, isStorageProvider, listStorageProviders, } from '../files-sdk/provider/index.js';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-export const ARTIFACT_STORAGE_CLIENT_NAME = 'artifacts';
-export const OBJECT_STORAGE_CLIENT_NAME = 'objects';
-export const DEFAULT_OBJECT_NAMESPACES = ['_staging', 'org-logos'];
-/**
- * Where the generic object store lives relative to the artifact store on a filesystem. Artifact
- * keys are `<artifactId>/<path>`, so an unprefixed object key like `org-logos/x.png` would read
- * back as an artifact directory named `org-logos` — listing, sweeping, and removal would all
- * cross the two. Filesystems therefore retain the historical `_objects` directory. Object-store
- * providers retain their historical unprefixed keys; the configured top-level namespace
- * allowlist keeps those keys disjoint from artifact ids without a rolling-deploy layout change.
- */
-export const OBJECT_STORE_PREFIX = '_objects';
-/** Default filesystem root, shared by the api and the sandbox so zero-config dev lines up. */
-export function defaultFsRoot() {
-    return join(tmpdir(), 'concepta-artifacts-artifacts');
-}
-function trimSlashes(value) {
-    return value.replace(/^\/+|\/+$/g, '');
-}
-/** Resolve and validate the case-insensitive top-level ObjectStore namespace allowlist. */
-export function resolveObjectNamespaces(namespaces = DEFAULT_OBJECT_NAMESPACES) {
-    const resolved = new Set();
-    for (const namespace of namespaces) {
-        const normalized = namespace.toLowerCase();
-        if (namespace === '' ||
-            namespace === '.' ||
-            namespace === '..' ||
-            namespace.includes('/') ||
-            namespace.includes('\\') ||
-            namespace.includes('\0') ||
-            Buffer.byteLength(namespace, 'utf8') > 255 ||
-            normalized === OBJECT_STORE_PREFIX ||
-            resolved.has(normalized)) {
-            throw new Error(`invalid or duplicate object namespace: ${JSON.stringify(namespace)}`);
-        }
-        resolved.add(normalized);
-    }
-    if (resolved.size === 0) {
-        throw new Error('at least one object namespace is required');
-    }
-    return resolved;
-}
-function joinPrefix(...parts) {
-    const joined = parts
-        .flatMap((part) => (part === undefined ? [] : [trimSlashes(part)]))
-        .filter((part) => part.length > 0)
-        .join('/');
-    return joined.length === 0 ? undefined : joined;
-}
-/** Fail fast on an unknown slug with the full list, rather than at the first upload. */
-export function assertStorageProvider(provider) {
-    if (!isStorageProvider(provider)) {
-        const known = listStorageProviders()
-            .map((candidate) => candidate.slug)
-            .join(', ');
-        throw new Error(`Unknown storage provider ${JSON.stringify(provider)}. Known providers: ${known}`);
-    }
-    return provider;
-}
-function providerConfig(cfg) {
-    if (cfg.provider !== 'fs')
-        return cfg.config ?? {};
-    // The filesystem adapter needs a root; every other provider names its store some other way.
-    return { root: defaultFsRoot(), ...cfg.config };
-}
-function driver(cfg, prefix) {
-    return createProviderStorageDriver({
-        provider: cfg.provider,
-        config: providerConfig(cfg),
-        ...(prefix === undefined ? {} : { prefix }),
-    });
-}
-export function createArtifactStorageDriver(cfg) {
-    return driver(cfg, joinPrefix(cfg.prefix));
-}
-export function createObjectStorageDriver(cfg) {
-    return driver(cfg, joinPrefix(cfg.prefix, cfg.provider === 'fs' ? OBJECT_STORE_PREFIX : ''));
-}
-export async function createArtifactStorageClient(cfg) {
-    return new StorageClient(ARTIFACT_STORAGE_CLIENT_NAME, await createArtifactStorageDriver(cfg));
-}
-export async function createObjectStorageClient(cfg) {
-    return new StorageClient(OBJECT_STORAGE_CLIENT_NAME, await createObjectStorageDriver(cfg));
-}
-//# sourceMappingURL=storage-driver.js.map

package/dist/artifacts/storage-driver.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"storage-driver.js","sourceRoot":"","sources":["../../src/artifacts/storage-driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAsB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EACL,2BAA2B,EAC3B,iBAAiB,EACjB,oBAAoB,GAGrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,MAAM,CAAC,MAAM,4BAA4B,GAAG,WAAW,CAAC;AACxD,MAAM,CAAC,MAAM,0BAA0B,GAAG,SAAS,CAAC;AACpD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,UAAU,EAAE,WAAW,CAAU,CAAC;AAE5E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;AA0B9C,8FAA8F;AAC9F,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,CAAC,MAAM,EAAE,EAAE,8BAA8B,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,OAAO,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AACzC,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,uBAAuB,CACrC,UAAU,GAAsB,yBAAyB;IAEzD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QAC3C,IACE,SAAS,KAAK,EAAE;YAChB,SAAS,KAAK,GAAG;YACjB,SAAS,KAAK,IAAI;YAClB,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,GAAG;YAC1C,UAAU,KAAK,mBAAmB;YAClC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EACxB,CAAC;YACD,MAAM,IAAI,KAAK,CACb,0CAA0C,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CACtE,CAAC;QACJ,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,UAAU,CAAC,GAAG,KAAgC;IACrD,MAAM,MAAM,GAAG,KAAK;SACjB,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAClE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACjC,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;AAClD,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,qBAAqB,CAAC,QAAgB;IACpD,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,oBAAoB,EAAE;aACjC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC;aAClC,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,IAAI,KAAK,CACb,4BAA4B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,sBAAsB,KAAK,EAAE,CAClF,CAAC;IACJ,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,cAAc,CAAC,GAA0B;IAChD,IAAI,GAAG,CAAC,QAAQ,KAAK,IAAI;QAAE,OAAO,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;IACnD,4FAA4F;IAC5F,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;AAClD,CAAC;AAED,SAAS,MAAM,CACb,GAA0B,EAC1B,MAA0B;IAE1B,OAAO,2BAA2B,CAAC;QACjC,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC;QAC3B,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;KAC5C,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,GAA0B;IAE1B,OAAO,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,GAA0B;IAE1B,OAAO,MAAM,CACX,GAAG,EACH,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,CACzE,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,GAA0B;IAE1B,OAAO,IAAI,aAAa,CACtB,4BAA4B,EAC5B,MAAM,2BAA2B,CAAC,GAAG,CAAC,CACvC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,GAA0B;IAE1B,OAAO,IAAI,aAAa,CACtB,0BAA0B,EAC1B,MAAM,yBAAyB,CAAC,GAAG,CAAC,CACrC,CAAC;AACJ,CAAC","sourcesContent":["import { StorageClient, type StorageDriver } from '../core/index.js';\nimport {\n  createProviderStorageDriver,\n  isStorageProvider,\n  listStorageProviders,\n  type StorageProviderConfig,\n  type StorageProviderName,\n} from '../files-sdk/provider/index.js';\nimport { tmpdir } from 'node:os';\nimport { join } from 'node:path';\n\nexport const ARTIFACT_STORAGE_CLIENT_NAME = 'artifacts';\nexport const OBJECT_STORAGE_CLIENT_NAME = 'objects';\nexport const DEFAULT_OBJECT_NAMESPACES = ['_staging', 'org-logos'] as const;\n\n/**\n * Where the generic object store lives relative to the artifact store on a filesystem. Artifact\n * keys are `<artifactId>/<path>`, so an unprefixed object key like `org-logos/x.png` would read\n * back as an artifact directory named `org-logos` — listing, sweeping, and removal would all\n * cross the two. Filesystems therefore retain the historical `_objects` directory. Object-store\n * providers retain their historical unprefixed keys; the configured top-level namespace\n * allowlist keeps those keys disjoint from artifact ids without a rolling-deploy layout change.\n */\nexport const OBJECT_STORE_PREFIX = '_objects';\n\n/**\n * Which store backs artifacts, and how to reach it. `provider` is any slug `@nestm/storage`\n * can build — `fs`, `s3`, `gcs`, `azure`, `r2`, `minio`, `supabase`, and ~40 more — so a\n * deployment picks its store from the environment instead of the platform shipping a driver\n * per backend. Only the selected provider's SDK is ever imported.\n */\nexport interface ArtifactStorageConfig {\n  provider: StorageProviderName;\n  /** Key prefix so artifacts can share a bucket (or a directory tree) with other apps. */\n  prefix?: string;\n  /**\n   * Flat provider settings: `bucket`/`region`/`endpoint` for an object store, `root` for the\n   * filesystem, `accountName`/`container` for Azure. Each provider reads what it needs.\n   * Credentials may be omitted wherever the provider's SDK resolves its own chain — on AWS that\n   * is the ECS task role, so S3 needs no long-lived keys in env.\n   */\n  config?: StorageProviderConfig;\n  /**\n   * Allowed top-level ObjectStore namespaces. Artifact ids matching one of these values are\n   * rejected, keeping the two public facades disjoint on providers where they share a key root.\n   */\n  objectNamespaces?: readonly string[];\n}\n\n/** Default filesystem root, shared by the api and the sandbox so zero-config dev lines up. */\nexport function defaultFsRoot(): string {\n  return join(tmpdir(), 'concepta-artifacts-artifacts');\n}\n\nfunction trimSlashes(value: string): string {\n  return value.replace(/^\\/+|\\/+$/g, '');\n}\n\n/** Resolve and validate the case-insensitive top-level ObjectStore namespace allowlist. */\nexport function resolveObjectNamespaces(\n  namespaces: readonly string[] = DEFAULT_OBJECT_NAMESPACES,\n): ReadonlySet<string> {\n  const resolved = new Set<string>();\n  for (const namespace of namespaces) {\n    const normalized = namespace.toLowerCase();\n    if (\n      namespace === '' ||\n      namespace === '.' ||\n      namespace === '..' ||\n      namespace.includes('/') ||\n      namespace.includes('\\\\') ||\n      namespace.includes('\\0') ||\n      Buffer.byteLength(namespace, 'utf8') > 255 ||\n      normalized === OBJECT_STORE_PREFIX ||\n      resolved.has(normalized)\n    ) {\n      throw new Error(\n        `invalid or duplicate object namespace: ${JSON.stringify(namespace)}`,\n      );\n    }\n    resolved.add(normalized);\n  }\n  if (resolved.size === 0) {\n    throw new Error('at least one object namespace is required');\n  }\n  return resolved;\n}\n\nfunction joinPrefix(...parts: Array<string | undefined>): string | undefined {\n  const joined = parts\n    .flatMap((part) => (part === undefined ? [] : [trimSlashes(part)]))\n    .filter((part) => part.length > 0)\n    .join('/');\n  return joined.length === 0 ? undefined : joined;\n}\n\n/** Fail fast on an unknown slug with the full list, rather than at the first upload. */\nexport function assertStorageProvider(provider: string): StorageProviderName {\n  if (!isStorageProvider(provider)) {\n    const known = listStorageProviders()\n      .map((candidate) => candidate.slug)\n      .join(', ');\n    throw new Error(\n      `Unknown storage provider ${JSON.stringify(provider)}. Known providers: ${known}`,\n    );\n  }\n  return provider;\n}\n\nfunction providerConfig(cfg: ArtifactStorageConfig): StorageProviderConfig {\n  if (cfg.provider !== 'fs') return cfg.config ?? {};\n  // The filesystem adapter needs a root; every other provider names its store some other way.\n  return { root: defaultFsRoot(), ...cfg.config };\n}\n\nfunction driver(\n  cfg: ArtifactStorageConfig,\n  prefix: string | undefined,\n): Promise<StorageDriver> {\n  return createProviderStorageDriver({\n    provider: cfg.provider,\n    config: providerConfig(cfg),\n    ...(prefix === undefined ? {} : { prefix }),\n  });\n}\n\nexport function createArtifactStorageDriver(\n  cfg: ArtifactStorageConfig,\n): Promise<StorageDriver> {\n  return driver(cfg, joinPrefix(cfg.prefix));\n}\n\nexport function createObjectStorageDriver(\n  cfg: ArtifactStorageConfig,\n): Promise<StorageDriver> {\n  return driver(\n    cfg,\n    joinPrefix(cfg.prefix, cfg.provider === 'fs' ? OBJECT_STORE_PREFIX : ''),\n  );\n}\n\nexport async function createArtifactStorageClient(\n  cfg: ArtifactStorageConfig,\n): Promise<StorageClient> {\n  return new StorageClient(\n    ARTIFACT_STORAGE_CLIENT_NAME,\n    await createArtifactStorageDriver(cfg),\n  );\n}\n\nexport async function createObjectStorageClient(\n  cfg: ArtifactStorageConfig,\n): Promise<StorageClient> {\n  return new StorageClient(\n    OBJECT_STORAGE_CLIENT_NAME,\n    await createObjectStorageDriver(cfg),\n  );\n}\n"]}