@marinoscar/platform-api 0.1.0-next.3 → 0.1.0-next.5

package/dist/exports/exports.options.d.ts

@@ -0,0 +1,140 @@
+import type { ModuleMetadata } from '@nestjs/common';
+import type { JobExecutionProfile } from '../jobs/index';
+import type { ExportDatamodel } from './datamodel';
+/**
+ * Injection token of the resolved {@link ExportsModuleOptions}.
+ *
+ * @stability experimental
+ */
+export declare const EXPORTS_OPTIONS: unique symbol;
+/**
+ * The `export.run` profile by default: 15 minutes, 2 attempts.
+ *
+ * @stability stable
+ */
+export declare const DEFAULT_EXPORT_JOB_PROFILE: JobExecutionProfile;
+/**
+ * The `export.purge` profile by default: 30 minutes, 3 attempts.
+ *
+ * @stability stable
+ */
+export declare const DEFAULT_EXPORT_PURGE_PROFILE: JobExecutionProfile;
+/**
+ * A job type an app ran before adopting the slice, kept registered as an
+ * alias so its rows still have a handler (a job `type` is permanent).
+ * Passed as `ExportsModule.forRoot({ legacyJobTypes })`.
+ *
+ * @extensionPoint option
+ * @stability experimental
+ * @example
+ * ```ts
+ * { type: 'health.export.purge', handles: 'purge', label: 'Health export expiry' }
+ * ```
+ */
+export interface ExportLegacyJobType {
+    /** The legacy type string (`health.export`). */
+    readonly type: string;
+    /** Which slice job it is processed as. */
+    readonly handles: 'run' | 'purge';
+    /** Its label in the jobs console; default the slice job's. */
+    readonly label?: string;
+    /**
+     * `run` only: maps a legacy payload to the `export.run` payload
+     * (`{ source, format, request, requestedById, scope, subjectId, orgId }`).
+     * Without it the payload must already have that shape.
+     */
+    readonly toPayload?: (payload: unknown) => unknown;
+}
+/**
+ * Options of `ExportsModule.forRoot()`. Every field but `datamodel` is
+ * optional.
+ *
+ * @stability experimental
+ */
+export interface ExportsModuleOptions {
+    /**
+     * The app's `Prisma.dmmf.datamodel`: the platform sources derive each
+     * registered model's columns from it. Required.
+     */
+    datamodel: ExportDatamodel;
+    /** The download-name slug (`my-app` in `my-app-user-data-2026-10-08.zip`); a function is read per export. Default `'app'`. */
+    appSlug?: string | (() => string);
+    /** Days an export file is kept before `export.purge` deletes it. Default 7. */
+    retentionDays?: number;
+    /** Lifetime of a signed download URL, in seconds. Default 300. */
+    downloadUrlTtlSeconds?: number;
+    /** Exports one subject (user or organization) may have pending or running. Default 3. */
+    maxInFlightPerSubject?: number;
+    /** Rows per page the platform sources read. Default 500. */
+    pageSize?: number;
+    /** The `export.run` execution profile. Default {@link DEFAULT_EXPORT_JOB_PROFILE}. */
+    jobProfile?: JobExecutionProfile;
+    /** The `export.purge` execution profile. Default {@link DEFAULT_EXPORT_PURGE_PROFILE}. */
+    purgeProfile?: JobExecutionProfile;
+    /** Whether to register the platform sources. Default both `true`. */
+    platformSources?: {
+        /** `user-data`. */
+        userData?: boolean;
+        /** `org-data`. */
+        orgData?: boolean;
+    };
+    /** Legacy job types kept registered as aliases (EvoPath's `health.export`, `health.export.purge`). */
+    legacyJobTypes?: readonly ExportLegacyJobType[];
+    /** Modules imported next to the slice: the app's host module binding the ports. */
+    imports?: ModuleMetadata['imports'];
+}
+/**
+ * {@link ExportsModuleOptions} with every default applied.
+ *
+ * @stability experimental
+ */
+export interface ResolvedExportsModuleOptions {
+    /** The app's datamodel. */
+    readonly datamodel: ExportDatamodel;
+    /** Reads the slug. */
+    readonly appSlug: () => string;
+    /** Days. */
+    readonly retentionDays: number;
+    /** Seconds. */
+    readonly downloadUrlTtlSeconds: number;
+    /** Per subject. */
+    readonly maxInFlightPerSubject: number;
+    /** Rows. */
+    readonly pageSize: number;
+    /** `export.run`. */
+    readonly jobProfile: JobExecutionProfile;
+    /** `export.purge`. */
+    readonly purgeProfile: JobExecutionProfile;
+    /** The platform sources registered. */
+    readonly platformSources: {
+        /** Whether `user-data` is registered. */
+        readonly userData: boolean;
+        /** Whether `org-data` is registered. */
+        readonly orgData: boolean;
+    };
+    /** The aliases. */
+    readonly legacyJobTypes: readonly ExportLegacyJobType[];
+    /** The modules imported next to the slice. */
+    readonly imports: NonNullable<ModuleMetadata['imports']>;
+}
+/**
+ * The app slug as a file-name segment: lowercase letters, digits and `-`;
+ * `app` when nothing survives.
+ *
+ * @param name - the application name or slug.
+ * @returns the slug.
+ *
+ * @stability experimental
+ */
+export declare function exportFileSlug(name: string): string;
+/**
+ * Validates `options` and applies the defaults.
+ *
+ * @param options - what the app passed.
+ * @returns the resolved options (frozen).
+ * @throws Error when `datamodel` is missing or a number or profile is invalid.
+ *
+ * @stability experimental
+ */
+export declare function resolveExportsModuleOptions(options: ExportsModuleOptions): ResolvedExportsModuleOptions;
+//# sourceMappingURL=exports.options.d.ts.map

package/dist/exports/exports.options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.options.d.ts","sourceRoot":"","sources":["../../src/exports/exports.options.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAQnD;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,OAAO,MAA2D,CAAC;AAEjG;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,mBAAqF,CAAC;AAE/H;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,EAAE,mBAAqF,CAAC;AAEjI;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAmB;IAClC,gDAAgD;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC;IAClC,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC;CACpD;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,SAAS,EAAE,eAAe,CAAC;IAC3B,8HAA8H;IAC9H,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IAClC,+EAA+E;IAC/E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kEAAkE;IAClE,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,yFAAyF;IACzF,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sFAAsF;IACtF,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,0FAA0F;IAC1F,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,qEAAqE;IACrE,eAAe,CAAC,EAAE;QAChB,mBAAmB;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,kBAAkB;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,sGAAsG;IACtG,cAAc,CAAC,EAAE,SAAS,mBAAmB,EAAE,CAAC;IAChD,mFAAmF;IACnF,OAAO,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,2BAA2B;IAC3B,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;IACpC,sBAAsB;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,MAAM,CAAC;IAC/B,YAAY;IACZ,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,eAAe;IACf,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,mBAAmB;IACnB,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,YAAY;IACZ,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,oBAAoB;IACpB,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAC;IACzC,sBAAsB;IACtB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAC3C,uCAAuC;IACvC,QAAQ,CAAC,eAAe,EAAE;QACxB,yCAAyC;QACzC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC3B,wCAAwC;QACxC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;KAC3B,CAAC;IACF,mBAAmB;IACnB,QAAQ,CAAC,cAAc,EAAE,SAAS,mBAAmB,EAAE,CAAC;IACxD,8CAA8C;IAC9C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;CAC1D;AAiBD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAUnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,oBAAoB,GAAG,4BAA4B,CAiCvG"}

package/dist/exports/exports.options.js

@@ -0,0 +1,114 @@
+"use strict";
+// =============================================================================
+// ExportsModule.forRoot() options (issue #744)
+// =============================================================================
+//
+// CODE OPTIONS, not environment variables or system settings, as in EvoPath:
+// a retention period or an in-flight cap is a product decision an app makes
+// once, not a knob an operator turns at run time. The defaults are EvoPath's
+// constants.
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_EXPORT_PURGE_PROFILE = exports.DEFAULT_EXPORT_JOB_PROFILE = exports.EXPORTS_OPTIONS = void 0;
+exports.exportFileSlug = exportFileSlug;
+exports.resolveExportsModuleOptions = resolveExportsModuleOptions;
+const exports_constants_1 = require("./exports.constants");
+/**
+ * Injection token of the resolved {@link ExportsModuleOptions}.
+ *
+ * @stability experimental
+ */
+exports.EXPORTS_OPTIONS = Symbol.for('@marinoscar/platform/exports/OPTIONS');
+/**
+ * The `export.run` profile by default: 15 minutes, 2 attempts.
+ *
+ * @stability stable
+ */
+exports.DEFAULT_EXPORT_JOB_PROFILE = Object.freeze({ maxRuntimeMs: 15 * 60 * 1000, maxAttempts: 2 });
+/**
+ * The `export.purge` profile by default: 30 minutes, 3 attempts.
+ *
+ * @stability stable
+ */
+exports.DEFAULT_EXPORT_PURGE_PROFILE = Object.freeze({ maxRuntimeMs: 30 * 60 * 1000, maxAttempts: 3 });
+function positiveInt(name, value) {
+    if (value === undefined)
+        return;
+    if (typeof value !== 'number' || !Number.isInteger(value) || value < 1) {
+        throw new Error(`ExportsModule.forRoot(): ${name} must be a positive integer (got ${String(value)})`);
+    }
+}
+function profile(name, value) {
+    if (value === undefined)
+        return;
+    positiveInt(`${name}.maxRuntimeMs`, value.maxRuntimeMs);
+    positiveInt(`${name}.maxAttempts`, value.maxAttempts);
+    const extra = Object.keys(value).filter((key) => key !== 'maxRuntimeMs' && key !== 'maxAttempts');
+    if (extra.length > 0)
+        throw new Error(`ExportsModule.forRoot(): ${name} carries only maxRuntimeMs and maxAttempts (got ${extra.join(', ')})`);
+}
+/**
+ * The app slug as a file-name segment: lowercase letters, digits and `-`;
+ * `app` when nothing survives.
+ *
+ * @param name - the application name or slug.
+ * @returns the slug.
+ *
+ * @stability experimental
+ */
+function exportFileSlug(name) {
+    const slug = name
+        .normalize('NFKD')
+        .replace(/[\u0300-\u036f]/g, '')
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '')
+        .slice(0, 40)
+        .replace(/-+$/g, '');
+    return slug || 'app';
+}
+/**
+ * Validates `options` and applies the defaults.
+ *
+ * @param options - what the app passed.
+ * @returns the resolved options (frozen).
+ * @throws Error when `datamodel` is missing or a number or profile is invalid.
+ *
+ * @stability experimental
+ */
+function resolveExportsModuleOptions(options) {
+    if (!options || !options.datamodel || !Array.isArray(options.datamodel.models)) {
+        throw new Error('ExportsModule.forRoot(): datamodel is required (pass the app\'s Prisma.dmmf.datamodel)');
+    }
+    positiveInt('retentionDays', options.retentionDays);
+    positiveInt('downloadUrlTtlSeconds', options.downloadUrlTtlSeconds);
+    positiveInt('maxInFlightPerSubject', options.maxInFlightPerSubject);
+    positiveInt('pageSize', options.pageSize);
+    profile('jobProfile', options.jobProfile);
+    profile('purgeProfile', options.purgeProfile);
+    for (const legacy of options.legacyJobTypes ?? []) {
+        if (typeof legacy.type !== 'string' || legacy.type.trim() === '')
+            throw new Error('ExportsModule.forRoot(): a legacy job type needs a type');
+        if (legacy.handles !== 'run' && legacy.handles !== 'purge') {
+            throw new Error(`ExportsModule.forRoot(): legacy job type "${legacy.type}" handles 'run' or 'purge'`);
+        }
+    }
+    const slug = options.appSlug;
+    return Object.freeze({
+        datamodel: options.datamodel,
+        appSlug: typeof slug === 'function' ? () => exportFileSlug(slug()) : () => exportFileSlug(slug ?? 'app'),
+        retentionDays: options.retentionDays ?? exports_constants_1.DEFAULT_EXPORT_RETENTION_DAYS,
+        downloadUrlTtlSeconds: options.downloadUrlTtlSeconds ?? exports_constants_1.DEFAULT_EXPORT_DOWNLOAD_URL_TTL_SECONDS,
+        maxInFlightPerSubject: options.maxInFlightPerSubject ?? exports_constants_1.DEFAULT_EXPORT_MAX_IN_FLIGHT,
+        pageSize: options.pageSize ?? exports_constants_1.DEFAULT_EXPORT_PAGE_SIZE,
+        jobProfile: Object.freeze({ ...(options.jobProfile ?? exports.DEFAULT_EXPORT_JOB_PROFILE) }),
+        purgeProfile: Object.freeze({ ...(options.purgeProfile ?? exports.DEFAULT_EXPORT_PURGE_PROFILE) }),
+        platformSources: Object.freeze({
+            userData: options.platformSources?.userData ?? true,
+            orgData: options.platformSources?.orgData ?? true,
+        }),
+        legacyJobTypes: Object.freeze([...(options.legacyJobTypes ?? [])]),
+        imports: [...(options.imports ?? [])],
+    });
+}
+//# sourceMappingURL=exports.options.js.map

package/dist/exports/exports.options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.options.js","sourceRoot":"","sources":["../../src/exports/exports.options.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,+CAA+C;AAC/C,gFAAgF;AAChF,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,6EAA6E;AAC7E,aAAa;AACb,gFAAgF;;;AA+JhF,wCAUC;AAWD,kEAiCC;AA/MD,2DAK6B;AAE7B;;;;GAIG;AACU,QAAA,eAAe,GAAkB,MAAM,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;AAEjG;;;;GAIG;AACU,QAAA,0BAA0B,GAAwB,MAAM,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;AAE/H;;;;GAIG;AACU,QAAA,4BAA4B,GAAwB,MAAM,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;AAuGjI,SAAS,WAAW,CAAC,IAAY,EAAE,KAAyB;IAC1D,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO;IAChC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACvE,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,oCAAoC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxG,CAAC;AACH,CAAC;AAED,SAAS,OAAO,CAAC,IAAY,EAAE,KAAsC;IACnE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO;IAChC,WAAW,CAAC,GAAG,IAAI,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IACxD,WAAW,CAAC,GAAG,IAAI,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IACtD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,cAAc,IAAI,GAAG,KAAK,aAAa,CAAC,CAAC;IAClG,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,mDAAmD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChJ,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,IAAI,GAAG,IAAI;SACd,SAAS,CAAC,MAAM,CAAC;SACjB,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;SAC/B,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;SACZ,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACvB,OAAO,IAAI,IAAI,KAAK,CAAC;AACvB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,2BAA2B,CAAC,OAA6B;IACvE,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,KAAK,CAAC,wFAAwF,CAAC,CAAC;IAC5G,CAAC;IACD,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACpD,WAAW,CAAC,uBAAuB,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACpE,WAAW,CAAC,uBAAuB,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACpE,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1C,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,cAAc,IAAI,EAAE,EAAE,CAAC;QAClD,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC7I,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,6CAA6C,MAAM,CAAC,IAAI,4BAA4B,CAAC,CAAC;QACxG,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAC7B,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,OAAO,EAAE,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,IAAI,KAAK,CAAC;QACxG,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,iDAA6B;QACrE,qBAAqB,EAAE,OAAO,CAAC,qBAAqB,IAAI,2DAAuC;QAC/F,qBAAqB,EAAE,OAAO,CAAC,qBAAqB,IAAI,gDAA4B;QACpF,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,4CAAwB;QACtD,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,kCAA0B,CAAC,EAAE,CAAC;QACpF,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,IAAI,oCAA4B,CAAC,EAAE,CAAC;QAC1F,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC;YAC7B,QAAQ,EAAE,OAAO,CAAC,eAAe,EAAE,QAAQ,IAAI,IAAI;YACnD,OAAO,EAAE,OAAO,CAAC,eAAe,EAAE,OAAO,IAAI,IAAI;SAClD,CAAC;QACF,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,CAAC;QAClE,OAAO,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;KACtC,CAAC,CAAC;AACL,CAAC"}

package/dist/exports/exports.service.d.ts

@@ -0,0 +1,111 @@
+import { type CreateExport, type ExportListResponse, type ExportSourcesResponse, type ExportView } from '@marinoscar/platform-contract/exports';
+import { JobsService } from '../jobs/index';
+import { type StorageProvider } from '../storage/index';
+import { type ExportJobRow } from './export-job';
+import { type ResolvedExportsModuleOptions } from './exports.options';
+import { type ExportsSystemData } from './ports';
+/**
+ * Who is asking: the authenticated principal, as the routes pass it.
+ *
+ * @stability experimental
+ */
+export interface ExportPrincipal {
+    /** The user id. */
+    readonly id: string;
+    /** Effective permissions (system grants plus the active organization's role). */
+    readonly permissions: readonly string[];
+    /** The active organization, when the credential has one. */
+    readonly activeOrgId?: string | null;
+}
+/**
+ * The 404 message: the same for "does not exist" and "not yours".
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_NOT_FOUND = "Export not found";
+/**
+ * The jobs table, as the service reads it.
+ *
+ * @stability experimental
+ */
+export interface ExportsJobsPrisma {
+    /** `jobs`. */
+    job: {
+        /** Counts the subject's in-flight exports. */
+        count(args: unknown): Promise<number>;
+        /** Lists the caller's exports. */
+        findMany(args: unknown): Promise<ExportJobRow[]>;
+        /** Reads one export. */
+        findFirst(args: unknown): Promise<ExportJobSubjectRow | null>;
+    };
+}
+/**
+ * A job row with its subject, as `GET /exports/:id` reads it.
+ *
+ * @stability experimental
+ */
+export interface ExportJobSubjectRow extends ExportJobRow {
+    /** `user` or `organization`. */
+    subjectType: string | null;
+    /** The user or organization id. */
+    subjectId: string | null;
+}
+/**
+ * The export routes' logic.
+ *
+ * @stability experimental
+ */
+export declare class ExportsService {
+    private readonly prisma;
+    private readonly jobs;
+    private readonly storage;
+    private readonly system;
+    private readonly options;
+    private readonly logger;
+    /** Overridable clock, for tests. */
+    now: () => Date;
+    constructor(prisma: ExportsJobsPrisma, jobs: JobsService, storage: StorageProvider, system: ExportsSystemData, options: ResolvedExportsModuleOptions);
+    /**
+     * The sources and formats the caller may use.
+     *
+     * @param principal - the caller.
+     * @returns the sources, in registry order.
+     */
+    sources(principal: ExportPrincipal): ExportSourcesResponse;
+    /**
+     * Queues an export.
+     *
+     * @param principal - the caller.
+     * @param body - the parsed `POST /exports` body.
+     * @returns the export, `pending`.
+     * @throws BadRequestException for an unknown source or format, or a request the source refuses.
+     * @throws ForbiddenException without the source's permission (or the cross-organization one).
+     * @throws NotFoundException for an unknown organization.
+     * @throws HttpException 429 over the in-flight cap.
+     */
+    create(principal: ExportPrincipal, body: CreateExport): Promise<ExportView>;
+    /**
+     * The caller's most recent exports, newest first, without download URLs.
+     *
+     * @param principal - the caller.
+     * @returns at most `EXPORT_LIST_LIMIT`.
+     */
+    list(principal: ExportPrincipal): Promise<ExportListResponse>;
+    /**
+     * One export, with a fresh download URL while it is ready.
+     *
+     * @param principal - the caller.
+     * @param exportId - the export (job) id.
+     * @returns the export.
+     * @throws NotFoundException unless the caller may see it.
+     */
+    get(principal: ExportPrincipal, exportId: string): Promise<ExportView>;
+    /** The views of `jobs`; one query for the files the committed ones name. */
+    private toViews;
+    private has;
+    /** Whether the caller may use the source at all (for the active organization or, cross-org, any). */
+    private mayUse;
+    /** See the file header, "Visibility". */
+    private maySee;
+}
+//# sourceMappingURL=exports.service.d.ts.map

package/dist/exports/exports.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.service.d.ts","sourceRoot":"","sources":["../../src/exports/exports.service.ts"],"names":[],"mappings":"AAmCA,OAAO,EAGL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EAEvB,KAAK,qBAAqB,EAC1B,KAAK,UAAU,EAChB,MAAM,uCAAuC,CAAC;AAG/C,OAAO,EAAE,WAAW,EAA2B,MAAM,eAAe,CAAC;AACrE,OAAO,EAAoB,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAiF,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAIhI,OAAO,EAAmB,KAAK,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAuB,KAAK,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAGtE;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,mBAAmB;IACnB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iFAAiF;IACjF,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IACxC,4DAA4D;IAC5D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,qBAAqB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,cAAc;IACd,GAAG,EAAE;QACH,8CAA8C;QAC9C,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,kCAAkC;QAClC,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QACjD,wBAAwB;QACxB,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAC;KAC/D,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,gCAAgC;IAChC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,mCAAmC;IACnC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAID;;;;GAIG;AACH,qBACa,cAAc;IAOE,OAAO,CAAC,QAAQ,CAAC,MAAM;IAChD,OAAO,CAAC,QAAQ,CAAC,IAAI;IACK,OAAO,CAAC,QAAQ,CAAC,OAAO;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO;IAVnD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmC;IAE1D,oCAAoC;IACpC,GAAG,EAAE,MAAM,IAAI,CAAoB;gBAGS,MAAM,EAAE,iBAAiB,EAClD,IAAI,EAAE,WAAW,EACS,OAAO,EAAE,eAAe,EACrB,MAAM,EAAE,iBAAiB,EAC7B,OAAO,EAAE,4BAA4B;IAGjF;;;;;OAKG;IACH,OAAO,CAAC,SAAS,EAAE,eAAe,GAAG,qBAAqB;IAwB1D;;;;;;;;;;OAUG;IACG,MAAM,CAAC,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IA+EjF;;;;;OAKG;IACG,IAAI,CAAC,SAAS,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAgBnE;;;;;;;OAOG;IACG,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IA6B5E,4EAA4E;YAC9D,OAAO;IAuBrB,OAAO,CAAC,GAAG;IAIX,qGAAqG;IACrG,OAAO,CAAC,MAAM;IAId,yCAAyC;IACzC,OAAO,CAAC,MAAM;CAQf"}