@os.io/nest-kit 0.0.1-alpha.0

package/dist/bootstrap/cache/config.js

@@ -0,0 +1,189 @@
+/* ------------------------------------------------------------------ */
+/*  Helpers                                                            */
+/* ------------------------------------------------------------------ */
+function readStr(get, name, ...suffixes) {
+    for (const suffix of suffixes) {
+        if (name) {
+            const v = get.str(`CACHE_${name.toUpperCase()}_${suffix}`);
+            if (v !== undefined)
+                return v;
+        }
+        const v = get.str(suffix);
+        if (v !== undefined)
+            return v;
+    }
+    return undefined;
+}
+function readNum(get, name, ...suffixes) {
+    for (const suffix of suffixes) {
+        if (name) {
+            const v = get.num(`CACHE_${name.toUpperCase()}_${suffix}`);
+            if (v !== undefined)
+                return v;
+        }
+        const v = get.num(suffix);
+        if (v !== undefined)
+            return v;
+    }
+    return undefined;
+}
+function buildAdapterOptions(name, opt, get, prefix) {
+    const rds = opt?.rdsEnabled ?? get.bool('RDS_CACHE_ENABLED', false);
+    const keyPrefix = opt?.keyPrefix ?? readStr(get, name, 'KEY_PREFIX', `${prefix}_KEY_PREFIX`);
+    const url = opt?.url ?? readStr(get, name, 'URL', `${prefix}_URL`) ?? 'redis://localhost:6379/0';
+    return { url, keyPrefix, ...(rds ? { socket: { tls: true } } : {}) };
+}
+function parseStores(get, options) {
+    const userStores = options?.stores;
+    const raw = userStores?.map((s) => s.type).join(',') ?? get.str('CACHE_STORE') ?? 'memory';
+    const types = raw.split(',').map((s) => s.trim());
+    return types.map((type) => {
+        const opt = userStores?.find((s) => s.type === type);
+        const storeName = opt?.name;
+        const maxVal = opt?.max ?? readNum(get, storeName, 'MAX', 'CACHE_MAX') ?? 100;
+        const ttlVal = opt?.ttl ?? options?.ttl ?? readNum(get, storeName, 'TTL', 'CACHE_TTL') ?? 60;
+        const base = {
+            type,
+            name: storeName,
+            adapter: opt?.adapter,
+            max: maxVal,
+            ttl: ttlVal,
+        };
+        if (type === 'memory')
+            return base;
+        const prefix = type === 'redis' ? 'REDIS' : 'VALKEY';
+        return {
+            ...base,
+            ...buildAdapterOptions(storeName, opt, get, prefix),
+            rdsEnabled: opt?.rdsEnabled ?? get.bool('RDS_CACHE_ENABLED', false),
+        };
+    });
+}
+function toMilliseconds(seconds) {
+    return seconds * 1000;
+}
+function buildCacheConfig(get, options) {
+    const KeyvClass = options?.keyv;
+    const stores = parseStores(get, options);
+    const base = {
+        ttl: options?.ttl ?? get.num('CACHE_TTL') ?? 60,
+        isGlobal: options?.isGlobal ?? get.bool('CACHE_IS_GLOBAL', false),
+    };
+    // When Keyv class is provided, build Keyv instances
+    if (KeyvClass) {
+        const keyvInstances = stores.map((s) => {
+            const ttlMs = toMilliseconds(s.ttl ?? 60);
+            if (s.type === 'memory') {
+                const adapterOptions = {};
+                if (s.max !== undefined)
+                    adapterOptions.lruSize = s.max;
+                const adapter = s.adapter ? new s.adapter(adapterOptions) : undefined;
+                // In-memory without adapter → Keyv default (no explicit store)
+                if (!adapter) {
+                    return { keyv: new KeyvClass({ ttl: ttlMs }), name: s.name };
+                }
+                return {
+                    keyv: new KeyvClass({ store: adapter, ttl: ttlMs }),
+                    name: s.name,
+                };
+            }
+            // redis / valkey — always need adapter
+            if (!s.adapter) {
+                throw new Error(`Cache store "${s.type}" requires an adapter. ` +
+                    `Install the package and pass adapter in config. ` +
+                    `e.g. { type: "${s.type}", adapter: Keyv${s.type === 'redis' ? 'Redis' : 'Valkey'} }`);
+            }
+            const adapterOptions = buildAdapterOptions(s.name, s, get, s.type === 'redis' ? 'REDIS' : 'VALKEY');
+            const keyvAdapter = new s.adapter(adapterOptions.url, adapterOptions);
+            return {
+                keyv: new KeyvClass({ store: keyvAdapter, ttl: ttlMs }),
+                name: s.name,
+            };
+        });
+        // Single store — flatten, include name if set
+        if (keyvInstances.length === 1) {
+            const entry = keyvInstances[0];
+            const out = { store: entry.keyv, ...base };
+            if (entry.name)
+                out.name = entry.name;
+            return out;
+        }
+        return { stores: keyvInstances, ...base };
+    }
+    // Without Keyv class — return raw config data
+    if (stores.length === 1) {
+        const out = { ...base, ...stores[0] };
+        if (stores[0].name)
+            out.name = stores[0].name;
+        return out;
+    }
+    return { ...base, stores };
+}
+/* ------------------------------------------------------------------ */
+/*  Public API                                                         */
+/* ------------------------------------------------------------------ */
+/**
+ * Build cache module options from environment variables.
+ *
+ * @example
+ * ```ts
+ * import Keyv from 'keyv';
+ * import KeyvRedis from '@keyv/redis';
+ * import { KeyvCacheableMemory } from 'cacheable';
+ *
+ * const cfg = configCache({
+ *   keyv: Keyv,
+ *   stores: [
+ *     { type: 'memory', adapter: KeyvCacheableMemory },
+ *     { type: 'redis', adapter: KeyvRedis },
+ *   ],
+ * });
+ * CacheModule.register(cfg);
+ * ```
+ *
+ * Environment variables:
+ * | Variable                  | Default                    | Description                               |
+ * |---------------------------|----------------------------|-------------------------------------------|
+ * | `CACHE_STORE`             | `memory`                   | Comma-separated store types               |
+ * | `CACHE_TTL`               | `60`                       | Default TTL (seconds)                     |
+ * | `CACHE_MAX`               | `100`                      | Max items (memory store)                  |
+ * | `CACHE_IS_GLOBAL`         | `false`                    | Register as global module                 |
+ * | `CACHE_{NAME}_URL`        | —                          | Named-store URL (overrides `REDIS_URL`)   |
+ * | `CACHE_{NAME}_KEY_PREFIX` | —                          | Named-store key prefix                    |
+ * | `CACHE_{NAME}_TTL`        | —                          | Named-store TTL (overrides `CACHE_TTL`)   |
+ * | `CACHE_{NAME}_MAX`        | —                          | Named-store max (overrides `CACHE_MAX`)   |
+ * | `REDIS_URL`               | `redis://localhost:6379/0` | Redis connection URL                      |
+ * | `REDIS_KEY_PREFIX`        | —                          | Redis key prefix                          |
+ * | `VALKEY_URL`              | `redis://localhost:6379/0` | Valkey connection URL                     |
+ * | `VALKEY_KEY_PREFIX`       | —                          | Valkey key prefix                         |
+ * | `RDS_CACHE_ENABLED`        | `false`                    | Enable TLS for Redis / Valkey             |
+ */
+export function configCache(options) {
+    return buildCacheConfig({
+        str: (key) => process.env[key],
+        num: (key) => (process.env[key] !== undefined ? Number(process.env[key]) : undefined),
+        bool: (key, def) => process.env[key] !== undefined
+            ? process.env[key] === 'true' || process.env[key] === '1'
+            : def,
+    }, options);
+}
+/**
+ * Build cache module options from `ConfigService`.
+ *
+ * @example
+ * ```ts
+ * CacheModule.registerAsync({
+ *   imports: [ConfigModule],
+ *   inject: [ConfigService],
+ *   useFactory: (cs) => configCacheAsync(cs, { keyv: Keyv, stores: [...] }),
+ * })
+ * ```
+ */
+export function configCacheAsync(configService, options) {
+    return buildCacheConfig({
+        str: (key) => configService.get(key),
+        num: (key) => configService.get(key),
+        bool: (key, def) => configService.get(key, def) ?? def,
+    }, options);
+}
+//# sourceMappingURL=config.js.map

package/dist/bootstrap/cache/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../packages/bootstrap/cache/config.ts"],"names":[],"mappings":"AAkHA,wEAAwE;AACxE,yEAAyE;AACzE,wEAAwE;AAExE,SAAS,OAAO,CACd,GAAc,EACd,IAAwB,EACxB,GAAG,QAAkB;IAErB,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC9B,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE,IAAI,MAAM,EAAE,CAAC,CAAC;YAC3D,IAAI,CAAC,KAAK,SAAS;gBAAE,OAAO,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,SAAS;YAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,OAAO,CACd,GAAc,EACd,IAAwB,EACxB,GAAG,QAAkB;IAErB,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC9B,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE,IAAI,MAAM,EAAE,CAAC,CAAC;YAC3D,IAAI,CAAC,KAAK,SAAS;gBAAE,OAAO,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,SAAS;YAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,mBAAmB,CAC1B,IAAwB,EACxB,GAA8B,EAC9B,GAAc,EACd,MAAc;IAEd,MAAM,GAAG,GAAG,GAAG,EAAE,UAAU,IAAI,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,GAAG,EAAE,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,MAAM,aAAa,CAAC,CAAC;IAC7F,MAAM,GAAG,GAAG,GAAG,EAAE,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,0BAA0B,CAAC;IAEjG,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AACvE,CAAC;AAED,SAAS,WAAW,CAAC,GAAc,EAAE,OAA4B;IAC/D,MAAM,UAAU,GAAG,OAAO,EAAE,MAAM,CAAC;IACnC,MAAM,GAAG,GAAG,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC;IAE3F,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAA8B,CAAC,CAAC;IAE9E,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACxB,MAAM,GAAG,GAAG,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACrD,MAAM,SAAS,GAAG,GAAG,EAAE,IAAI,CAAC;QAE5B,MAAM,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,GAAG,CAAC;QAC9E,MAAM,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,OAAO,EAAE,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;QAE7F,MAAM,IAAI,GAAkB;YAC1B,IAAI;YACJ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,GAAG,EAAE,OAAO;YACrB,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,MAAM;SACZ,CAAC;QAEF,IAAI,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAEnC,MAAM,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;QAErD,OAAO;YACL,GAAG,IAAI;YACP,GAAG,mBAAmB,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC;YACnD,UAAU,EAAE,GAAG,EAAE,UAAU,IAAI,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC;SACpE,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,cAAc,CAAC,OAAe;IACrC,OAAO,OAAO,GAAG,IAAI,CAAC;AACxB,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAc,EAAE,OAA4B;IACpE,MAAM,SAAS,GAAG,OAAO,EAAE,IAAI,CAAC;IAChC,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAEzC,MAAM,IAAI,GAAgB;QACxB,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE;QAC/C,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC;KAClE,CAAC;IAEF,oDAAoD;IACpD,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;YAE1C,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACxB,MAAM,cAAc,GAA4B,EAAE,CAAC;gBACnD,IAAI,CAAC,CAAC,GAAG,KAAK,SAAS;oBAAE,cAAc,CAAC,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC;gBACxD,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAEtE,+DAA+D;gBAC/D,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO,EAAE,IAAI,EAAE,IAAI,SAAS,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC/D,CAAC;gBAED,OAAO;oBACL,IAAI,EAAE,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;oBACnD,IAAI,EAAE,CAAC,CAAC,IAAI;iBACb,CAAC;YACJ,CAAC;YAED,uCAAuC;YACvC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CACb,gBAAgB,CAAC,CAAC,IAAI,yBAAyB;oBAC7C,kDAAkD;oBAClD,iBAAiB,CAAC,CAAC,IAAI,mBAAmB,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,IAAI,CACxF,CAAC;YACJ,CAAC;YAED,MAAM,cAAc,GAAG,mBAAmB,CACxC,CAAC,CAAC,IAAI,EACN,CAAC,EACD,GAAG,EACH,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CACxC,CAAC;YACF,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YAEtE,OAAO;gBACL,IAAI,EAAE,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;gBACvD,IAAI,EAAE,CAAC,CAAC,IAAI;aACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,8CAA8C;QAC9C,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,GAAG,GAAgB,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC;YACxD,IAAI,KAAK,CAAC,IAAI;gBAAE,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YACtC,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED,8CAA8C;IAC9C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,GAAG,GAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;YAAE,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;IAED,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC;AAC7B,CAAC;AAED,wEAAwE;AACxE,yEAAyE;AACzE,wEAAwE;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,WAAW,CAAC,OAA4B;IACtD,OAAO,gBAAgB,CACrB;QACE,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;QAC9B,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrF,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CACjB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS;YAC5B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,GAAG;YACzD,CAAC,CAAC,GAAG;KACV,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gBAAgB,CAC9B,aAA4B,EAC5B,OAA4B;IAE5B,OAAO,gBAAgB,CACrB;QACE,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAS,GAAG,CAAC;QAC5C,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAS,GAAG,CAAC;QAC5C,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAU,GAAG,EAAE,GAAG,CAAC,IAAI,GAAG;KAChE,EACD,OAAO,CACR,CAAC;AACJ,CAAC"}

package/dist/bootstrap/cache/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @os.io/nest-kit/bootstrap/cache
+ *
+ * Cache module configuration bootstrapper for NestJS applications.
+ * Supports memory, Redis, Valkey, and multi-tier caching.
+ *
+ * @module
+ * @packageDocumentation
+ */
+export { configCache, configCacheAsync } from './config';
+//# sourceMappingURL=index.d.ts.map

package/dist/bootstrap/cache/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/bootstrap/cache/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC"}

package/dist/bootstrap/cache/index.js

@@ -0,0 +1,11 @@
+/**
+ * @os.io/nest-kit/bootstrap/cache
+ *
+ * Cache module configuration bootstrapper for NestJS applications.
+ * Supports memory, Redis, Valkey, and multi-tier caching.
+ *
+ * @module
+ * @packageDocumentation
+ */
+export { configCache, configCacheAsync } from './config';
+//# sourceMappingURL=index.js.map

package/dist/bootstrap/cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/bootstrap/cache/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC"}

package/dist/bootstrap/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @os.io/nest-kit/bootstrap
+ *
+ * Helpers and configuration bootstrappers for popular NestJS modules such as
+ * Swagger, Scalar, Cache, TypeORM, Mongoose, etc. Designed to be called directly from
+ * your application's `main.ts` or `app.module.ts`.
+ *
+ * ## Sub-modules
+ *
+ * - `@os.io/nest-kit/bootstrap/swagger`   — Swagger UI
+ * - `@os.io/nest-kit/bootstrap/scalar`    — Scalar API Reference
+ * - `@os.io/nest-kit/bootstrap/cache`     — CacheModule setup
+ * - `@os.io/nest-kit/bootstrap/typeorm`   — TypeORM setup, CRUD factories, Unit of Work
+ *
+ * @module
+ * @packageDocumentation
+ */
+export * from './swagger';
+export * from './scalar';
+export * from './cache';
+//# sourceMappingURL=index.d.ts.map

package/dist/bootstrap/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../packages/bootstrap/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/bootstrap/index.js

@@ -0,0 +1,21 @@
+/**
+ * @os.io/nest-kit/bootstrap
+ *
+ * Helpers and configuration bootstrappers for popular NestJS modules such as
+ * Swagger, Scalar, Cache, TypeORM, Mongoose, etc. Designed to be called directly from
+ * your application's `main.ts` or `app.module.ts`.
+ *
+ * ## Sub-modules
+ *
+ * - `@os.io/nest-kit/bootstrap/swagger`   — Swagger UI
+ * - `@os.io/nest-kit/bootstrap/scalar`    — Scalar API Reference
+ * - `@os.io/nest-kit/bootstrap/cache`     — CacheModule setup
+ * - `@os.io/nest-kit/bootstrap/typeorm`   — TypeORM setup, CRUD factories, Unit of Work
+ *
+ * @module
+ * @packageDocumentation
+ */
+export * from './swagger';
+export * from './scalar';
+export * from './cache';
+//# sourceMappingURL=index.js.map

package/dist/bootstrap/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../packages/bootstrap/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/bootstrap/scalar/api-docs.d.ts

@@ -0,0 +1,39 @@
+import type { INestApplication } from '@nestjs/common';
+import type { SwaggerDocumentOptions } from '@nestjs/swagger';
+import type { NestJSReferenceConfiguration } from '@scalar/nestjs-api-reference';
+/**
+ * Options for {@link configScalarApiDoc}.
+ */
+export interface ConfigScalarOptions {
+    /** OpenAPI title (default: `'NestJS API'`). */
+    title?: string;
+    /** OpenAPI description (default: `''`). */
+    description?: string;
+    /** OpenAPI version (default: `'1.0'`). */
+    version?: string;
+    /** Mount path (default: `'api/docs'`). */
+    path?: string;
+    /** Extra options forwarded to `apiReference()` from `@scalar/nestjs-api-reference`. */
+    scalarOptions?: NestJSReferenceConfiguration;
+    /** Extra options forwarded to `SwaggerModule.createDocument`. */
+    swaggerDocumentOptions?: SwaggerDocumentOptions;
+}
+/**
+ * Configure Scalar API Reference on the NestJS app.
+ *
+ * Mounts the Scalar UI at the given `path` (default `api/docs`).
+ * Requires `@scalar/nestjs-api-reference` to be installed.
+ *
+ * @example
+ * ```ts
+ * import { configScalarApiDoc } from '@os.io/nest-kit/bootstrap/scalar';
+ *
+ * configScalarApiDoc(app);
+ * // Browse to http://localhost:3000/api/docs
+ * ```
+ *
+ * @param app - The NestJS application instance.
+ * @param options - Configuration overrides.
+ */
+export declare function configScalarApiDoc(app: INestApplication, options?: ConfigScalarOptions): void;
+//# sourceMappingURL=api-docs.d.ts.map

package/dist/bootstrap/scalar/api-docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-docs.d.ts","sourceRoot":"","sources":["../../../packages/bootstrap/scalar/api-docs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AAYjF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,aAAa,CAAC,EAAE,4BAA4B,CAAC;IAC7C,iEAAiE;IACjE,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,IAAI,CA0B7F"}

package/dist/bootstrap/scalar/api-docs.js

@@ -0,0 +1,41 @@
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { createRequire } from 'node:module';
+const _require = createRequire(__filename);
+/**
+ * Configure Scalar API Reference on the NestJS app.
+ *
+ * Mounts the Scalar UI at the given `path` (default `api/docs`).
+ * Requires `@scalar/nestjs-api-reference` to be installed.
+ *
+ * @example
+ * ```ts
+ * import { configScalarApiDoc } from '@oxpo/nest-kit/bootstrap/scalar';
+ *
+ * configScalarApiDoc(app);
+ * // Browse to http://localhost:3000/api/docs
+ * ```
+ *
+ * @param app - The NestJS application instance.
+ * @param options - Configuration overrides.
+ */
+export function configScalarApiDoc(app, options) {
+    const builder = new DocumentBuilder()
+        .setTitle(options?.title ?? 'NestJS API')
+        .setDescription(options?.description ?? '')
+        .setVersion(options?.version ?? '1.0')
+        .addBearerAuth();
+    const config = builder.build();
+    const document = SwaggerModule.createDocument(app, config, options?.swaggerDocumentOptions);
+    try {
+        const { apiReference } = _require('@scalar/nestjs-api-reference');
+        app.use(options?.path ?? 'api/docs', apiReference({
+            spec: { content: document },
+            ...options?.scalarOptions,
+        }));
+    }
+    catch {
+        console.warn('[@oxpo/nest-kit] @scalar/nestjs-api-reference is not installed. ' +
+            'Skipping Scalar API docs setup.');
+    }
+}
+//# sourceMappingURL=api-docs.js.map

package/dist/bootstrap/scalar/api-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-docs.js","sourceRoot":"","sources":["../../../packages/bootstrap/scalar/api-docs.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,QAAQ,GAAG,aAAa,CAAC,UAAU,CAA4B,CAAC;AA0BtE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAqB,EAAE,OAA6B;IACrF,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE;SAClC,QAAQ,CAAC,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC;SACxC,cAAc,CAAC,OAAO,EAAE,WAAW,IAAI,EAAE,CAAC;SAC1C,UAAU,CAAC,OAAO,EAAE,OAAO,IAAI,KAAK,CAAC;SACrC,aAAa,EAAE,CAAC;IAEnB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,CAAC,CAAC;IAE5F,IAAI,CAAC;QACH,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,8BAA8B,CAAsB,CAAC;QAEvF,GAAG,CAAC,GAAG,CACL,OAAO,EAAE,IAAI,IAAI,UAAU,EAC3B,YAAY,CAAC;YACX,IAAI,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE;YAC3B,GAAG,OAAO,EAAE,aAAa;SAC1B,CAAC,CACH,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,IAAI,CACV,kEAAkE;YAChE,iCAAiC,CACpC,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/bootstrap/scalar/index.d.ts

@@ -0,0 +1,39 @@
+import type { INestApplication } from '@nestjs/common';
+import type { SwaggerDocumentOptions } from '@nestjs/swagger';
+import type { NestJSReferenceConfiguration } from '@scalar/nestjs-api-reference';
+/**
+ * Options for {@link configScalarApiDoc}.
+ */
+export interface ConfigScalarOptions {
+    /** OpenAPI title (default: `'NestJS API'`). */
+    title?: string;
+    /** OpenAPI description (default: `''`). */
+    description?: string;
+    /** OpenAPI version (default: `'1.0'`). */
+    version?: string;
+    /** Mount path (default: `'api/docs'`). */
+    path?: string;
+    /** Extra options forwarded to `apiReference()` from `@scalar/nestjs-api-reference`. */
+    scalarOptions?: NestJSReferenceConfiguration;
+    /** Extra options forwarded to `SwaggerModule.createDocument`. */
+    swaggerDocumentOptions?: SwaggerDocumentOptions;
+}
+/**
+ * Configure Scalar API Reference on the NestJS app.
+ *
+ * Mounts the Scalar UI at the given `path` (default `api/docs`).
+ * Requires `@scalar/nestjs-api-reference` to be installed.
+ *
+ * @example
+ * ```ts
+ * import { configScalarApiDoc } from '@os.io/nest-kit/bootstrap/scalar';
+ *
+ * configScalarApiDoc(app);
+ * // Browse to http://localhost:3000/api/docs
+ * ```
+ *
+ * @param app - The NestJS application instance.
+ * @param options - Configuration overrides.
+ */
+export declare function configScalarApiDoc(app: INestApplication, options?: ConfigScalarOptions): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/bootstrap/scalar/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/bootstrap/scalar/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AAYjF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,aAAa,CAAC,EAAE,4BAA4B,CAAC;IAC7C,iEAAiE;IACjE,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,IAAI,CA0B7F"}

package/dist/bootstrap/scalar/index.js

@@ -0,0 +1,41 @@
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { createRequire } from 'node:module';
+const _require = createRequire(__filename);
+/**
+ * Configure Scalar API Reference on the NestJS app.
+ *
+ * Mounts the Scalar UI at the given `path` (default `api/docs`).
+ * Requires `@scalar/nestjs-api-reference` to be installed.
+ *
+ * @example
+ * ```ts
+ * import { configScalarApiDoc } from '@os.io/nest-kit/bootstrap/scalar';
+ *
+ * configScalarApiDoc(app);
+ * // Browse to http://localhost:3000/api/docs
+ * ```
+ *
+ * @param app - The NestJS application instance.
+ * @param options - Configuration overrides.
+ */
+export function configScalarApiDoc(app, options) {
+    const builder = new DocumentBuilder()
+        .setTitle(options?.title ?? 'NestJS API')
+        .setDescription(options?.description ?? '')
+        .setVersion(options?.version ?? '1.0')
+        .addBearerAuth();
+    const config = builder.build();
+    const document = SwaggerModule.createDocument(app, config, options?.swaggerDocumentOptions);
+    try {
+        const { apiReference } = _require('@scalar/nestjs-api-reference');
+        app.use(options?.path ?? 'api/docs', apiReference({
+            spec: { content: document },
+            ...options?.scalarOptions,
+        }));
+    }
+    catch {
+        console.warn('[@os.io/nest-kit] @scalar/nestjs-api-reference is not installed. ' +
+            'Skipping Scalar API docs setup.');
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/bootstrap/scalar/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/bootstrap/scalar/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,QAAQ,GAAG,aAAa,CAAC,UAAU,CAA4B,CAAC;AA0BtE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAqB,EAAE,OAA6B;IACrF,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE;SAClC,QAAQ,CAAC,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC;SACxC,cAAc,CAAC,OAAO,EAAE,WAAW,IAAI,EAAE,CAAC;SAC1C,UAAU,CAAC,OAAO,EAAE,OAAO,IAAI,KAAK,CAAC;SACrC,aAAa,EAAE,CAAC;IAEnB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,CAAC,CAAC;IAE5F,IAAI,CAAC;QACH,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,8BAA8B,CAAsB,CAAC;QAEvF,GAAG,CAAC,GAAG,CACL,OAAO,EAAE,IAAI,IAAI,UAAU,EAC3B,YAAY,CAAC;YACX,IAAI,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE;YAC3B,GAAG,OAAO,EAAE,aAAa;SAC1B,CAAC,CACH,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,IAAI,CACV,mEAAmE;YACjE,iCAAiC,CACpC,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/bootstrap/swagger/api-docs.d.ts

@@ -0,0 +1,73 @@
+import type { INestApplication } from '@nestjs/common';
+import type { SwaggerCustomOptions, SwaggerDocumentOptions } from '@nestjs/swagger';
+import type { NestJSReferenceConfiguration } from '@scalar/nestjs-api-reference';
+/**
+ * Options for {@link configSwagger}.
+ */
+export interface ConfigSwaggerOptions {
+    /** OpenAPI title (default: `'NestJS API'`). */
+    title?: string;
+    /** OpenAPI description (default: `''`). */
+    description?: string;
+    /** OpenAPI version (default: `'1.0'`). */
+    version?: string;
+    /** Mount path (default: `'api/docs'`). */
+    path?: string;
+    /** Extra options forwarded to `SwaggerModule.setup`. */
+    swaggerCustomOptions?: SwaggerCustomOptions;
+    /** Extra options forwarded to `SwaggerModule.createDocument`. */
+    swaggerDocumentOptions?: SwaggerDocumentOptions;
+}
+/**
+ * Configure Swagger UI on the NestJS app.
+ *
+ * Mounts the Swagger UI at the given `path` (default `api/docs`).
+ *
+ * @example
+ * ```ts
+ * import { configSwagger } from '@os.io/nest-kit/bootstrap/swagger';
+ *
+ * configSwagger(app);
+ * // Browse to http://localhost:3000/api/docs
+ * ```
+ *
+ * @param app - The NestJS application instance.
+ * @param options - Configuration overrides.
+ */
+export declare function configSwagger(app: INestApplication, options?: ConfigSwaggerOptions): void;
+/**
+ * Options for {@link configScalarApiDoc}.
+ */
+export interface ConfigScalarOptions {
+    /** OpenAPI title (default: `'NestJS API'`). */
+    title?: string;
+    /** OpenAPI description (default: `''`). */
+    description?: string;
+    /** OpenAPI version (default: `'1.0'`). */
+    version?: string;
+    /** Mount path (default: `'api/docs'`). */
+    path?: string;
+    /** Extra options forwarded to `apiReference()` from `@scalar/nestjs-api-reference`. */
+    scalarOptions?: NestJSReferenceConfiguration;
+    /** Extra options forwarded to `SwaggerModule.createDocument`. */
+    swaggerDocumentOptions?: SwaggerDocumentOptions;
+}
+/**
+ * Configure Scalar API Reference on the NestJS app.
+ *
+ * Mounts the Scalar UI at the given `path` (default `api/docs`).
+ * Requires `@scalar/nestjs-api-reference` to be installed.
+ *
+ * @example
+ * ```ts
+ * import { configScalarApiDoc } from '@os.io/nest-kit/bootstrap/swagger';
+ *
+ * configScalarApiDoc(app);
+ * // Browse to http://localhost:3000/api/docs
+ * ```
+ *
+ * @param app - The NestJS application instance.
+ * @param options - Configuration overrides.
+ */
+export declare function configScalarApiDoc(app: INestApplication, options?: ConfigScalarOptions): void;
+//# sourceMappingURL=api-docs.d.ts.map

package/dist/bootstrap/swagger/api-docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-docs.d.ts","sourceRoot":"","sources":["../../../packages/bootstrap/swagger/api-docs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AAcjF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,iEAAiE;IACjE,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,IAAI,CA0CzF;AAID;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,aAAa,CAAC,EAAE,4BAA4B,CAAC;IAC7C,iEAAiE;IACjE,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAiD7F"}

package/dist/bootstrap/swagger/api-docs.js

@@ -0,0 +1,87 @@
+const DEFAULT_FAVICON_URL = 'https://scalar.com/favicon.svg';
+/**
+ * Configure Swagger UI on the NestJS app.
+ *
+ * Mounts the Swagger UI at the given `path` (default `api/docs`).
+ *
+ * @example
+ * ```ts
+ * import { configSwagger } from '@oxpo/nest-kit/bootstrap/swagger';
+ *
+ * configSwagger(app);
+ * // Browse to http://localhost:3000/api/docs
+ * ```
+ *
+ * @param app - The NestJS application instance.
+ * @param options - Configuration overrides.
+ */
+export function configSwagger(app, options) {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        const { DocumentBuilder, SwaggerModule } = require('@nestjs/swagger');
+        const builder = new DocumentBuilder()
+            .setTitle(options?.title ?? 'NestJS API')
+            .setDescription(options?.description ?? '')
+            .setVersion(options?.version ?? '1.0')
+            .addBearerAuth();
+        const config = builder.build();
+        const document = SwaggerModule.createDocument(app, config, options?.swaggerDocumentOptions);
+        SwaggerModule.setup(options?.path ?? 'api/docs', app, document, {
+            customfavIcon: options?.swaggerCustomOptions?.customfavIcon ?? DEFAULT_FAVICON_URL,
+            ...options?.swaggerCustomOptions,
+            swaggerOptions: {
+                persistAuthorization: true,
+                ...options?.swaggerCustomOptions?.swaggerOptions,
+            },
+        });
+    }
+    catch {
+        console.warn('[@oxpo/nest-kit] @nestjs/swagger is not installed. Skipping Swagger UI setup.');
+    }
+}
+/**
+ * Configure Scalar API Reference on the NestJS app.
+ *
+ * Mounts the Scalar UI at the given `path` (default `api/docs`).
+ * Requires `@scalar/nestjs-api-reference` to be installed.
+ *
+ * @example
+ * ```ts
+ * import { configScalarApiDoc } from '@oxpo/nest-kit/bootstrap/swagger';
+ *
+ * configScalarApiDoc(app);
+ * // Browse to http://localhost:3000/api/docs
+ * ```
+ *
+ * @param app - The NestJS application instance.
+ * @param options - Configuration overrides.
+ */
+export function configScalarApiDoc(app, options) {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        const { DocumentBuilder, SwaggerModule } = require('@nestjs/swagger');
+        const builder = new DocumentBuilder()
+            .setTitle(options?.title ?? 'NestJS API')
+            .setDescription(options?.description ?? '')
+            .setVersion(options?.version ?? '1.0')
+            .addBearerAuth();
+        const config = builder.build();
+        const document = SwaggerModule.createDocument(app, config, options?.swaggerDocumentOptions);
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-require-imports
+            const { apiReference } = require('@scalar/nestjs-api-reference');
+            app.use(options?.path ?? 'api/docs', apiReference({
+                spec: { content: document },
+                ...options?.scalarOptions,
+            }));
+        }
+        catch {
+            console.warn('[@oxpo/nest-kit] @scalar/nestjs-api-reference is not installed. ' +
+                'Skipping Scalar API docs setup.');
+        }
+    }
+    catch {
+        console.warn('[@oxpo/nest-kit] @nestjs/swagger is not installed. Skipping Scalar API docs setup.');
+    }
+}
+//# sourceMappingURL=api-docs.js.map

package/dist/bootstrap/swagger/api-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-docs.js","sourceRoot":"","sources":["../../../packages/bootstrap/swagger/api-docs.ts"],"names":[],"mappings":"AAYA,MAAM,mBAAmB,GAAG,gCAAgC,CAAC;AAsB7D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa,CAAC,GAAqB,EAAE,OAA8B;IACjF,IAAI,CAAC;QACH,iEAAiE;QACjE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAenE,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE;aAClC,QAAQ,CAAC,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC;aACxC,cAAc,CAAC,OAAO,EAAE,WAAW,IAAI,EAAE,CAAC;aAC1C,UAAU,CAAC,OAAO,EAAE,OAAO,IAAI,KAAK,CAAC;aACrC,aAAa,EAAE,CAAC;QAEnB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,CAAC,CAAC;QAE5F,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,UAAU,EAAE,GAAG,EAAE,QAAQ,EAAE;YAC9D,aAAa,EAAE,OAAO,EAAE,oBAAoB,EAAE,aAAa,IAAI,mBAAmB;YAClF,GAAG,OAAO,EAAE,oBAAoB;YAChC,cAAc,EAAE;gBACd,oBAAoB,EAAE,IAAI;gBAC1B,GAAG,OAAO,EAAE,oBAAoB,EAAE,cAAc;aACjD;SACF,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,IAAI,CACV,+EAA+E,CAChF,CAAC;IACJ,CAAC;AACH,CAAC;AAsBD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAqB,EAAE,OAA6B;IACrF,IAAI,CAAC;QACH,iEAAiE;QACjE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,iBAAiB,CASnE,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE;aAClC,QAAQ,CAAC,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC;aACxC,cAAc,CAAC,OAAO,EAAE,WAAW,IAAI,EAAE,CAAC;aAC1C,UAAU,CAAC,OAAO,EAAE,OAAO,IAAI,KAAK,CAAC;aACrC,aAAa,EAAE,CAAC;QAEnB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,CAAC,CAAC;QAE5F,IAAI,CAAC;YACH,iEAAiE;YACjE,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,8BAA8B,CAI9D,CAAC;YAEF,GAAG,CAAC,GAAG,CACL,OAAO,EAAE,IAAI,IAAI,UAAU,EAC3B,YAAY,CAAC;gBACX,IAAI,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE;gBAC3B,GAAG,OAAO,EAAE,aAAa;aAC1B,CAAC,CACH,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,IAAI,CACV,kEAAkE;gBAChE,iCAAiC,CACpC,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,IAAI,CACV,oFAAoF,CACrF,CAAC;IACJ,CAAC;AACH,CAAC"}