@marinoscar/platform-contract 0.1.0-next.3 → 0.1.0-next.4

package/dist/cjs/exports/schemas.d.ts

@@ -0,0 +1,386 @@
+import { z } from 'zod';
+import { EXPORT_COLUMN_TYPES, EXPORT_REQUEST_FIELD_KINDS, EXPORT_SCOPES, EXPORT_STATUSES } from './constants.js';
+/**
+ * The entries of the status enum.
+ *
+ * @stability experimental
+ */
+export type ExportStatusEnum = {
+    [K in (typeof EXPORT_STATUSES)[number]]: K;
+};
+/**
+ * The entries of the scope enum.
+ *
+ * @stability experimental
+ */
+export type ExportScopeEnum = {
+    [K in (typeof EXPORT_SCOPES)[number]]: K;
+};
+/**
+ * The entries of the column type enum.
+ *
+ * @stability experimental
+ */
+export type ExportColumnTypeEnum = {
+    [K in (typeof EXPORT_COLUMN_TYPES)[number]]: K;
+};
+/**
+ * The entries of the request field kind enum.
+ *
+ * @stability experimental
+ */
+export type ExportRequestFieldKindEnum = {
+    [K in (typeof EXPORT_REQUEST_FIELD_KINDS)[number]]: K;
+};
+/**
+ * An export's derived status.
+ *
+ * @stability experimental
+ */
+export declare const exportStatusSchema: z.ZodEnum<ExportStatusEnum>;
+/**
+ * A source's scope.
+ *
+ * @stability experimental
+ */
+export declare const exportScopeSchema: z.ZodEnum<ExportScopeEnum>;
+/**
+ * A column's value type.
+ *
+ * @stability experimental
+ */
+export declare const exportColumnTypeSchema: z.ZodEnum<ExportColumnTypeEnum>;
+/**
+ * A request field's kind.
+ *
+ * @stability experimental
+ */
+export declare const exportRequestFieldKindSchema: z.ZodEnum<ExportRequestFieldKindEnum>;
+/**
+ * One exported value: text, a number, a boolean or `null`. Dates travel as
+ * ISO 8601 strings; binary columns are never exported.
+ *
+ * @stability experimental
+ */
+export declare const exportCellSchema: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+/**
+ * One exported value.
+ *
+ * @stability experimental
+ */
+export type ExportCell = z.infer<typeof exportCellSchema>;
+/**
+ * A column's writer-specific typing: flat scalars a custom writer reads (a
+ * Parquet logical type, a unit), at most `EXPORT_COLUMN_META_MAX_KEYS` keys.
+ * The built-in writers ignore it and never write it.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export declare const exportColumnMetaSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+/**
+ * One column's `meta`.
+ *
+ * @stability experimental
+ */
+export type ExportColumnMeta = z.infer<typeof exportColumnMetaSchema>;
+/**
+ * One column of a dataset: its key (the CSV header and the JSON key), a human
+ * label (the XLSX header), its value type and, optionally, writer-specific
+ * `meta`.
+ *
+ * @stability experimental
+ */
+export declare const exportColumnSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    type: z.ZodEnum<ExportColumnTypeEnum>;
+    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+}, z.core.$strip>;
+/**
+ * One column of a dataset.
+ *
+ * @stability experimental
+ */
+export type ExportColumn = z.infer<typeof exportColumnSchema>;
+/**
+ * One dataset inside the JSON file.
+ *
+ * @stability experimental
+ */
+export declare const exportJsonDatasetSchema: z.ZodObject<{
+    title: z.ZodString;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<ExportColumnTypeEnum>;
+        meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+    }, z.core.$strip>>;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+}, z.core.$strip>;
+/**
+ * One dataset inside the JSON file.
+ *
+ * @stability experimental
+ */
+export type ExportJsonDataset = z.infer<typeof exportJsonDatasetSchema>;
+/**
+ * The JSON writer's file, version 1: the contract a reader of a JSON export
+ * validates against. `datasets` is keyed by dataset name, in the order the
+ * source produced them.
+ *
+ * @stability experimental
+ */
+export declare const exportJsonFileSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    source: z.ZodString;
+    exportedAt: z.ZodString;
+    datasets: z.ZodRecord<z.ZodString, z.ZodObject<{
+        title: z.ZodString;
+        columns: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            label: z.ZodString;
+            type: z.ZodEnum<ExportColumnTypeEnum>;
+            meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+        }, z.core.$strip>>;
+        rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    }, z.core.$strip>>;
+}, z.core.$strict>;
+/**
+ * The JSON writer's file, version 1.
+ *
+ * @stability experimental
+ */
+export type ExportJsonFile = z.infer<typeof exportJsonFileSchema>;
+/**
+ * One choice of a `select` request field.
+ *
+ * @stability experimental
+ */
+export declare const exportRequestFieldOptionSchema: z.ZodObject<{
+    value: z.ZodString;
+    label: z.ZodString;
+}, z.core.$strip>;
+/**
+ * One field of a source's request, as the export dialog draws it. Derived
+ * from the source's request schema unless the source declares its own.
+ *
+ * @stability experimental
+ */
+export declare const exportRequestFieldSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    kind: z.ZodEnum<ExportRequestFieldKindEnum>;
+    required: z.ZodBoolean;
+    description: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>>;
+    default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
+}, z.core.$strip>;
+/**
+ * One field of a source's request.
+ *
+ * @stability experimental
+ */
+export type ExportRequestField = z.infer<typeof exportRequestFieldSchema>;
+/**
+ * One output format a source offers.
+ *
+ * @stability experimental
+ */
+export declare const exportFormatDescriptorSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    extension: z.ZodString;
+    mimeType: z.ZodString;
+}, z.core.$strip>;
+/**
+ * One output format a source offers.
+ *
+ * @stability experimental
+ */
+export type ExportFormatDescriptor = z.infer<typeof exportFormatDescriptorSchema>;
+/**
+ * One source the caller may use.
+ *
+ * @stability experimental
+ */
+export declare const exportSourceDescriptorSchema: z.ZodObject<{
+    id: z.ZodString;
+    scope: z.ZodEnum<ExportScopeEnum>;
+    label: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    formats: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        extension: z.ZodString;
+        mimeType: z.ZodString;
+    }, z.core.$strip>>;
+    fields: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        kind: z.ZodEnum<ExportRequestFieldKindEnum>;
+        required: z.ZodBoolean;
+        description: z.ZodOptional<z.ZodString>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodString;
+        }, z.core.$strip>>>;
+        default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
+    }, z.core.$strip>>;
+    crossOrg: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * One source the caller may use.
+ *
+ * @stability experimental
+ */
+export type ExportSourceDescriptor = z.infer<typeof exportSourceDescriptorSchema>;
+/**
+ * `GET /exports/sources`.
+ *
+ * @stability experimental
+ */
+export declare const exportSourcesResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        scope: z.ZodEnum<ExportScopeEnum>;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        formats: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+            extension: z.ZodString;
+            mimeType: z.ZodString;
+        }, z.core.$strip>>;
+        fields: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            label: z.ZodString;
+            kind: z.ZodEnum<ExportRequestFieldKindEnum>;
+            required: z.ZodBoolean;
+            description: z.ZodOptional<z.ZodString>;
+            options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                value: z.ZodString;
+                label: z.ZodString;
+            }, z.core.$strip>>>;
+            default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
+        }, z.core.$strip>>;
+        crossOrg: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * `GET /exports/sources`.
+ *
+ * @stability experimental
+ */
+export type ExportSourcesResponse = z.infer<typeof exportSourcesResponseSchema>;
+/**
+ * `POST /exports`. `request` is validated by the source's own schema, at the
+ * route and again when the job starts. `orgId` names the organization of an
+ * `org` source (default: the caller's active organization); another
+ * organization needs the source's cross-organization permission.
+ *
+ * @stability experimental
+ */
+export declare const createExportSchema: z.ZodObject<{
+    source: z.ZodString;
+    format: z.ZodString;
+    request: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    orgId: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * `POST /exports`, as parsed.
+ *
+ * @stability experimental
+ */
+export type CreateExport = z.infer<typeof createExportSchema>;
+/**
+ * `POST /exports`, as a client sends it.
+ *
+ * @stability experimental
+ */
+export type CreateExportInput = z.input<typeof createExportSchema>;
+/**
+ * A short-lived signed download, present only on `GET /exports/:id` of a
+ * `ready` export. Never logged, never stored.
+ *
+ * @stability experimental
+ */
+export declare const exportDownloadSchema: z.ZodObject<{
+    url: z.ZodString;
+    expiresAt: z.ZodString;
+}, z.core.$strip>;
+/**
+ * A short-lived signed download.
+ *
+ * @stability experimental
+ */
+export type ExportDownload = z.infer<typeof exportDownloadSchema>;
+/**
+ * One export. Its id is the job id: there is no export table.
+ *
+ * @stability experimental
+ */
+export declare const exportSchema: z.ZodObject<{
+    id: z.ZodString;
+    source: z.ZodString;
+    format: z.ZodString;
+    scope: z.ZodEnum<ExportScopeEnum>;
+    orgId: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<ExportStatusEnum>;
+    createdAt: z.ZodString;
+    completedAt: z.ZodNullable<z.ZodString>;
+    expiresAt: z.ZodNullable<z.ZodString>;
+    fileName: z.ZodNullable<z.ZodString>;
+    mimeType: z.ZodNullable<z.ZodString>;
+    sizeBytes: z.ZodNullable<z.ZodNumber>;
+    rowCounts: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    error: z.ZodNullable<z.ZodString>;
+    download: z.ZodNullable<z.ZodObject<{
+        url: z.ZodString;
+        expiresAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * One export.
+ *
+ * @stability experimental
+ */
+export type ExportView = z.infer<typeof exportSchema>;
+/**
+ * `GET /exports`: the caller's most recent exports, newest first, without
+ * download URLs.
+ *
+ * @stability experimental
+ */
+export declare const exportListResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        source: z.ZodString;
+        format: z.ZodString;
+        scope: z.ZodEnum<ExportScopeEnum>;
+        orgId: z.ZodNullable<z.ZodString>;
+        status: z.ZodEnum<ExportStatusEnum>;
+        createdAt: z.ZodString;
+        completedAt: z.ZodNullable<z.ZodString>;
+        expiresAt: z.ZodNullable<z.ZodString>;
+        fileName: z.ZodNullable<z.ZodString>;
+        mimeType: z.ZodNullable<z.ZodString>;
+        sizeBytes: z.ZodNullable<z.ZodNumber>;
+        rowCounts: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+        error: z.ZodNullable<z.ZodString>;
+        download: z.ZodNullable<z.ZodObject<{
+            url: z.ZodString;
+            expiresAt: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * `GET /exports`.
+ *
+ * @stability experimental
+ */
+export type ExportListResponse = z.infer<typeof exportListResponseSchema>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/cjs/exports/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/exports/schemas.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAGL,mBAAmB,EAInB,0BAA0B,EAC1B,aAAa,EACb,eAAe,EAChB,MAAM,gBAAgB,CAAC;AAMxB;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AAC9E;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AAC3E;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AACtF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AAEnG;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAA2B,CAAC;AACvF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAyB,CAAC;AACnF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAA+B,CAAC;AACnG;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAsC,CAAC;AAStH;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,CAK3F,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,yFAO/B,CAAC;AAEL;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;iBAS7B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;iBAOlC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;kBAWtB,CAAC;AAEZ;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMlE;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;iBAKzC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;iBAenC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;iBASvC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;iBAevC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGtC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAMhF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;kBAWpB,CAAC;AAEZ;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAMnE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;iBAK/B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;iBA+BvB,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAEtD;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;iBAGnC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}

package/dist/cjs/exports/schemas.js

@@ -0,0 +1,288 @@
+"use strict";
+// =============================================================================
+// The exports slice's wire shapes (issue #744, PP-9.2)
+// =============================================================================
+//
+// The request and responses of `/api/exports` (sources, create, list, get),
+// the format-free cell, column and request-field shapes a source declares, and
+// the JSON writer's file envelope (`schemaVersion: 1`). Shared by
+// `@marinoscar/platform-api/exports` (which wraps them as DTOs, so the OpenAPI
+// document is generated from them) and `@marinoscar/platform-web/exports`.
+//
+// Every object schema is exported so an app can `.extend()` it (a source with
+// richer request fields, a client that reads an extra field).
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportListResponseSchema = exports.exportSchema = exports.exportDownloadSchema = exports.createExportSchema = exports.exportSourcesResponseSchema = exports.exportSourceDescriptorSchema = exports.exportFormatDescriptorSchema = exports.exportRequestFieldSchema = exports.exportRequestFieldOptionSchema = exports.exportJsonFileSchema = exports.exportJsonDatasetSchema = exports.exportColumnSchema = exports.exportColumnMetaSchema = exports.exportCellSchema = exports.exportRequestFieldKindSchema = exports.exportColumnTypeSchema = exports.exportScopeSchema = exports.exportStatusSchema = void 0;
+const zod_1 = require("zod");
+const constants_js_1 = require("./constants.js");
+/**
+ * An export's derived status.
+ *
+ * @stability experimental
+ */
+exports.exportStatusSchema = zod_1.z.enum(constants_js_1.EXPORT_STATUSES);
+/**
+ * A source's scope.
+ *
+ * @stability experimental
+ */
+exports.exportScopeSchema = zod_1.z.enum(constants_js_1.EXPORT_SCOPES);
+/**
+ * A column's value type.
+ *
+ * @stability experimental
+ */
+exports.exportColumnTypeSchema = zod_1.z.enum(constants_js_1.EXPORT_COLUMN_TYPES);
+/**
+ * A request field's kind.
+ *
+ * @stability experimental
+ */
+exports.exportRequestFieldKindSchema = zod_1.z.enum(constants_js_1.EXPORT_REQUEST_FIELD_KINDS);
+const exportId = zod_1.z.string().regex(constants_js_1.EXPORT_ID_PATTERN);
+const isoDateTime = zod_1.z.string().datetime({ offset: true });
+// =============================================================================
+// Cells, columns and the JSON file
+// =============================================================================
+/**
+ * One exported value: text, a number, a boolean or `null`. Dates travel as
+ * ISO 8601 strings; binary columns are never exported.
+ *
+ * @stability experimental
+ */
+exports.exportCellSchema = zod_1.z.union([
+    zod_1.z.string(),
+    zod_1.z.number(),
+    zod_1.z.boolean(),
+    zod_1.z.null(),
+]);
+/**
+ * A column's writer-specific typing: flat scalars a custom writer reads (a
+ * Parquet logical type, a unit), at most `EXPORT_COLUMN_META_MAX_KEYS` keys.
+ * The built-in writers ignore it and never write it.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+exports.exportColumnMetaSchema = zod_1.z
+    .record(zod_1.z.string().min(1).max(constants_js_1.EXPORT_COLUMN_META_MAX_LENGTH), zod_1.z.union([zod_1.z.string().max(constants_js_1.EXPORT_COLUMN_META_MAX_LENGTH), zod_1.z.number(), zod_1.z.boolean()]))
+    .refine((meta) => Object.keys(meta).length <= constants_js_1.EXPORT_COLUMN_META_MAX_KEYS, {
+    message: `meta carries at most ${constants_js_1.EXPORT_COLUMN_META_MAX_KEYS} keys`,
+});
+/**
+ * One column of a dataset: its key (the CSV header and the JSON key), a human
+ * label (the XLSX header), its value type and, optionally, writer-specific
+ * `meta`.
+ *
+ * @stability experimental
+ */
+exports.exportColumnSchema = zod_1.z.object({
+    /** Machine name: the CSV header and the JSON key. */
+    key: zod_1.z.string().min(1).max(128),
+    /** Human header: the XLSX header. */
+    label: zod_1.z.string().min(1).max(256),
+    /** The value type; numbers are never formula-neutralised in a CSV. */
+    type: exports.exportColumnTypeSchema,
+    /** Writer-specific typing (for example a Parquet logical type). The built-in writers ignore it. */
+    meta: exports.exportColumnMetaSchema.optional(),
+});
+/**
+ * One dataset inside the JSON file.
+ *
+ * @stability experimental
+ */
+exports.exportJsonDatasetSchema = zod_1.z.object({
+    /** The human title (an XLSX sheet name). */
+    title: zod_1.z.string(),
+    /** The columns, in order. */
+    columns: zod_1.z.array(exports.exportColumnSchema),
+    /** The rows, keyed by column key. */
+    rows: zod_1.z.array(zod_1.z.record(zod_1.z.string(), exports.exportCellSchema)),
+});
+/**
+ * The JSON writer's file, version 1: the contract a reader of a JSON export
+ * validates against. `datasets` is keyed by dataset name, in the order the
+ * source produced them.
+ *
+ * @stability experimental
+ */
+exports.exportJsonFileSchema = zod_1.z
+    .object({
+    /** {@link EXPORT_JSON_SCHEMA_VERSION}. */
+    schemaVersion: zod_1.z.literal(constants_js_1.EXPORT_JSON_SCHEMA_VERSION),
+    /** The source id (`user-data`). */
+    source: exportId,
+    /** When the export was produced. */
+    exportedAt: isoDateTime,
+    /** One entry per dataset. */
+    datasets: zod_1.z.record(zod_1.z.string().regex(constants_js_1.EXPORT_DATASET_PATTERN), exports.exportJsonDatasetSchema),
+})
+    .strict();
+// =============================================================================
+// GET /exports/sources
+// =============================================================================
+/**
+ * One choice of a `select` request field.
+ *
+ * @stability experimental
+ */
+exports.exportRequestFieldOptionSchema = zod_1.z.object({
+    /** The value sent. */
+    value: zod_1.z.string(),
+    /** What the dialog shows. */
+    label: zod_1.z.string(),
+});
+/**
+ * One field of a source's request, as the export dialog draws it. Derived
+ * from the source's request schema unless the source declares its own.
+ *
+ * @stability experimental
+ */
+exports.exportRequestFieldSchema = zod_1.z.object({
+    /** The key in `request`. */
+    key: zod_1.z.string().min(1).max(64),
+    /** The field's label. */
+    label: zod_1.z.string().min(1),
+    /** What to draw. */
+    kind: exports.exportRequestFieldKindSchema,
+    /** Whether the request is refused without it. */
+    required: zod_1.z.boolean(),
+    /** One line under the field. */
+    description: zod_1.z.string().optional(),
+    /** The choices of a `select`. */
+    options: zod_1.z.array(exports.exportRequestFieldOptionSchema).optional(),
+    /** The value when the request omits it. */
+    default: zod_1.z.union([zod_1.z.string(), zod_1.z.boolean()]).optional(),
+});
+/**
+ * One output format a source offers.
+ *
+ * @stability experimental
+ */
+exports.exportFormatDescriptorSchema = zod_1.z.object({
+    /** The writer id (`csv`), sent as `format`. */
+    id: exportId,
+    /** What the dialog calls it. */
+    label: zod_1.z.string(),
+    /** The file extension, without the dot (`zip` for `csv`). */
+    extension: zod_1.z.string(),
+    /** The file's media type. */
+    mimeType: zod_1.z.string(),
+});
+/**
+ * One source the caller may use.
+ *
+ * @stability experimental
+ */
+exports.exportSourceDescriptorSchema = zod_1.z.object({
+    /** The source id (`user-data`), sent as `source`. */
+    id: exportId,
+    /** Whose data it exports. */
+    scope: exports.exportScopeSchema,
+    /** What the dialog calls it. */
+    label: zod_1.z.string(),
+    /** One sentence about what it contains. */
+    description: zod_1.z.string().optional(),
+    /** The formats it offers, in registry order. */
+    formats: zod_1.z.array(exports.exportFormatDescriptorSchema),
+    /** The request fields the dialog draws (empty for a source without options). */
+    fields: zod_1.z.array(exports.exportRequestFieldSchema),
+    /** For an `org` source: whether the caller may export an organization other than the active one. */
+    crossOrg: zod_1.z.boolean(),
+});
+/**
+ * `GET /exports/sources`.
+ *
+ * @stability experimental
+ */
+exports.exportSourcesResponseSchema = zod_1.z.object({
+    /** The sources, in registry order. */
+    items: zod_1.z.array(exports.exportSourceDescriptorSchema),
+});
+// =============================================================================
+// POST /exports
+// =============================================================================
+/**
+ * `POST /exports`. `request` is validated by the source's own schema, at the
+ * route and again when the job starts. `orgId` names the organization of an
+ * `org` source (default: the caller's active organization); another
+ * organization needs the source's cross-organization permission.
+ *
+ * @stability experimental
+ */
+exports.createExportSchema = zod_1.z
+    .object({
+    /** The source id. */
+    source: exportId,
+    /** The format (writer) id. */
+    format: exportId,
+    /** The source's request; `{}` when it takes none. */
+    request: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).default({}),
+    /** An `org` source's organization; ignored by a `user` source. */
+    orgId: zod_1.z.string().uuid().optional(),
+})
+    .strict();
+// =============================================================================
+// The export
+// =============================================================================
+/**
+ * A short-lived signed download, present only on `GET /exports/:id` of a
+ * `ready` export. Never logged, never stored.
+ *
+ * @stability experimental
+ */
+exports.exportDownloadSchema = zod_1.z.object({
+    /** A signed GET with `Content-Disposition: attachment`. */
+    url: zod_1.z.string().url(),
+    /** When the URL stops working. */
+    expiresAt: isoDateTime,
+});
+/**
+ * One export. Its id is the job id: there is no export table.
+ *
+ * @stability experimental
+ */
+exports.exportSchema = zod_1.z.object({
+    /** The export (job) id. */
+    id: zod_1.z.string().uuid(),
+    /** The source id. */
+    source: exportId,
+    /** The format id. */
+    format: exportId,
+    /** Whose data. */
+    scope: exports.exportScopeSchema,
+    /** The organization of an `org` export, else `null`. */
+    orgId: zod_1.z.string().uuid().nullable(),
+    /** The derived status. */
+    status: exports.exportStatusSchema,
+    /** When it was requested. */
+    createdAt: isoDateTime,
+    /** When the file was produced, or the job settled. */
+    completedAt: isoDateTime.nullable(),
+    /** When the file is deleted. */
+    expiresAt: isoDateTime.nullable(),
+    /** The download name. */
+    fileName: zod_1.z.string().nullable(),
+    /** The file's media type. */
+    mimeType: zod_1.z.string().nullable(),
+    /** The file's size in bytes. */
+    sizeBytes: zod_1.z.number().int().nonnegative().nullable(),
+    /** Rows per dataset. */
+    rowCounts: zod_1.z.record(zod_1.z.string(), zod_1.z.number().int().nonnegative()).nullable(),
+    /** The fixed failure message of a `failed` export, else `null`. */
+    error: zod_1.z.string().nullable(),
+    /** The signed download (`GET /exports/:id` of a `ready` export only), else `null`. */
+    download: exports.exportDownloadSchema.nullable(),
+});
+/**
+ * `GET /exports`: the caller's most recent exports, newest first, without
+ * download URLs.
+ *
+ * @stability experimental
+ */
+exports.exportListResponseSchema = zod_1.z.object({
+    /** At most `EXPORT_LIST_LIMIT`. */
+    items: zod_1.z.array(exports.exportSchema),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/cjs/exports/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/exports/schemas.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,uDAAuD;AACvD,gFAAgF;AAChF,EAAE;AACF,4EAA4E;AAC5E,+EAA+E;AAC/E,kEAAkE;AAClE,+EAA+E;AAC/E,2EAA2E;AAC3E,EAAE;AACF,8EAA8E;AAC9E,8DAA8D;AAC9D,gFAAgF;;;AAEhF,6BAAwB;AAExB,iDAUwB;AA+BxB;;;;GAIG;AACU,QAAA,kBAAkB,GAAgC,OAAC,CAAC,IAAI,CAAC,8BAAe,CAAC,CAAC;AACvF;;;;GAIG;AACU,QAAA,iBAAiB,GAA+B,OAAC,CAAC,IAAI,CAAC,4BAAa,CAAC,CAAC;AACnF;;;;GAIG;AACU,QAAA,sBAAsB,GAAoC,OAAC,CAAC,IAAI,CAAC,kCAAmB,CAAC,CAAC;AACnG;;;;GAIG;AACU,QAAA,4BAA4B,GAA0C,OAAC,CAAC,IAAI,CAAC,yCAA0B,CAAC,CAAC;AAEtH,MAAM,QAAQ,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,gCAAiB,CAAC,CAAC;AACrD,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AAE1D,gFAAgF;AAChF,mCAAmC;AACnC,gFAAgF;AAEhF;;;;;GAKG;AACU,QAAA,gBAAgB,GAAoE,OAAC,CAAC,KAAK,CAAC;IACvG,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,MAAM,EAAE;IACV,OAAC,CAAC,OAAO,EAAE;IACX,OAAC,CAAC,IAAI,EAAE;CACT,CAAC,CAAC;AASH;;;;;;;GAOG;AACU,QAAA,sBAAsB,GAAG,OAAC;KACpC,MAAM,CACL,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,4CAA6B,CAAC,EACpD,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,4CAA6B,CAAC,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAClF;KACA,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,0CAA2B,EAAE;IACzE,OAAO,EAAE,wBAAwB,0CAA2B,OAAO;CACpE,CAAC,CAAC;AASL;;;;;;GAMG;AACU,QAAA,kBAAkB,GAAG,OAAC,CAAC,MAAM,CAAC;IACzC,qDAAqD;IACrD,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC/B,qCAAqC;IACrC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACjC,sEAAsE;IACtE,IAAI,EAAE,8BAAsB;IAC5B,mGAAmG;IACnG,IAAI,EAAE,8BAAsB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AASH;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9C,4CAA4C;IAC5C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,6BAA6B;IAC7B,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,0BAAkB,CAAC;IACpC,qCAAqC;IACrC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,wBAAgB,CAAC,CAAC;CACtD,CAAC,CAAC;AASH;;;;;;GAMG;AACU,QAAA,oBAAoB,GAAG,OAAC;KAClC,MAAM,CAAC;IACN,0CAA0C;IAC1C,aAAa,EAAE,OAAC,CAAC,OAAO,CAAC,yCAA0B,CAAC;IACpD,mCAAmC;IACnC,MAAM,EAAE,QAAQ;IAChB,oCAAoC;IACpC,UAAU,EAAE,WAAW;IACvB,6BAA6B;IAC7B,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qCAAsB,CAAC,EAAE,+BAAuB,CAAC;CACtF,CAAC;KACD,MAAM,EAAE,CAAC;AASZ,gFAAgF;AAChF,uBAAuB;AACvB,gFAAgF;AAEhF;;;;GAIG;AACU,QAAA,8BAA8B,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,sBAAsB;IACtB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,6BAA6B;IAC7B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH;;;;;GAKG;AACU,QAAA,wBAAwB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/C,4BAA4B;IAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IAC9B,yBAAyB;IACzB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,oBAAoB;IACpB,IAAI,EAAE,oCAA4B;IAClC,iDAAiD;IACjD,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE;IACrB,gCAAgC;IAChC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,iCAAiC;IACjC,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,sCAA8B,CAAC,CAAC,QAAQ,EAAE;IAC3D,2CAA2C;IAC3C,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAC;AASH;;;;GAIG;AACU,QAAA,4BAA4B,GAAG,OAAC,CAAC,MAAM,CAAC;IACnD,+CAA+C;IAC/C,EAAE,EAAE,QAAQ;IACZ,gCAAgC;IAChC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,6DAA6D;IAC7D,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,6BAA6B;IAC7B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;CACrB,CAAC,CAAC;AASH;;;;GAIG;AACU,QAAA,4BAA4B,GAAG,OAAC,CAAC,MAAM,CAAC;IACnD,qDAAqD;IACrD,EAAE,EAAE,QAAQ;IACZ,6BAA6B;IAC7B,KAAK,EAAE,yBAAiB;IACxB,gCAAgC;IAChC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,2CAA2C;IAC3C,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,gDAAgD;IAChD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,oCAA4B,CAAC;IAC9C,gFAAgF;IAChF,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,gCAAwB,CAAC;IACzC,oGAAoG;IACpG,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE;CACtB,CAAC,CAAC;AASH;;;;GAIG;AACU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,sCAAsC;IACtC,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,oCAA4B,CAAC;CAC7C,CAAC,CAAC;AASH,gFAAgF;AAChF,gBAAgB;AAChB,gFAAgF;AAEhF;;;;;;;GAOG;AACU,QAAA,kBAAkB,GAAG,OAAC;KAChC,MAAM,CAAC;IACN,qBAAqB;IACrB,MAAM,EAAE,QAAQ;IAChB,8BAA8B;IAC9B,MAAM,EAAE,QAAQ;IAChB,qDAAqD;IACrD,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACtD,kEAAkE;IAClE,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC;KACD,MAAM,EAAE,CAAC;AAgBZ,gFAAgF;AAChF,aAAa;AACb,gFAAgF;AAEhF;;;;;GAKG;AACU,QAAA,oBAAoB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3C,2DAA2D;IAC3D,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,kCAAkC;IAClC,SAAS,EAAE,WAAW;CACvB,CAAC,CAAC;AASH;;;;GAIG;AACU,QAAA,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IACnC,2BAA2B;IAC3B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IACrB,qBAAqB;IACrB,MAAM,EAAE,QAAQ;IAChB,qBAAqB;IACrB,MAAM,EAAE,QAAQ;IAChB,kBAAkB;IAClB,KAAK,EAAE,yBAAiB;IACxB,wDAAwD;IACxD,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACnC,0BAA0B;IAC1B,MAAM,EAAE,0BAAkB;IAC1B,6BAA6B;IAC7B,SAAS,EAAE,WAAW;IACtB,sDAAsD;IACtD,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE;IACnC,gCAAgC;IAChC,SAAS,EAAE,WAAW,CAAC,QAAQ,EAAE;IACjC,yBAAyB;IACzB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,6BAA6B;IAC7B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,gCAAgC;IAChC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IACpD,wBAAwB;IACxB,SAAS,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1E,mEAAmE;IACnE,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,sFAAsF;IACtF,QAAQ,EAAE,4BAAoB,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAC;AASH;;;;;GAKG;AACU,QAAA,wBAAwB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/C,mCAAmC;IACnC,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,oBAAY,CAAC;CAC7B,CAAC,CAAC"}