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

package/dist/esm/exports/constants.d.ts

@@ -0,0 +1,123 @@
+/**
+ * The route group, relative to `/api`: `POST /exports`, `GET /exports`,
+ * `GET /exports/:id`.
+ *
+ * @stability experimental
+ */
+export declare const EXPORTS_PATH = "/exports";
+/**
+ * `GET /exports/sources`: the sources and formats the caller may use.
+ *
+ * @stability experimental
+ */
+export declare const EXPORTS_SOURCES_PATH = "/exports/sources";
+/**
+ * An export's derived status, in lifecycle order:
+ *
+ * - `pending`, `running`: the job's own status;
+ * - `ready`: the result is recorded, its file exists and it has not expired;
+ * - `expired`: the result is recorded but the file is gone or past its expiry;
+ * - `failed`: the job settled without a result.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_STATUSES: readonly ["pending", "running", "ready", "expired", "failed"];
+/**
+ * One derived status.
+ *
+ * @stability experimental
+ */
+export type ExportStatus = (typeof EXPORT_STATUSES)[number];
+/**
+ * Whose data a source exports: one user's (`user`) or one organization's (`org`).
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_SCOPES: readonly ["user", "org"];
+/**
+ * One scope.
+ *
+ * @stability experimental
+ */
+export type ExportScope = (typeof EXPORT_SCOPES)[number];
+/**
+ * A column's value type. `date` is a calendar day (`YYYY-MM-DD`), `datetime`
+ * an ISO 8601 instant; both travel as strings.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_COLUMN_TYPES: readonly ["string", "number", "boolean", "date", "datetime"];
+/**
+ * One column type.
+ *
+ * @stability experimental
+ */
+export type ExportColumnType = (typeof EXPORT_COLUMN_TYPES)[number];
+/**
+ * The most keys one column's `meta` may carry.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_COLUMN_META_MAX_KEYS = 16;
+/**
+ * The longest `meta` key, and the longest `meta` string value, in characters.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_COLUMN_META_MAX_LENGTH = 256;
+/**
+ * The kind of one request field the export dialog draws: a date picker, a
+ * checkbox, a select or a text box.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_REQUEST_FIELD_KINDS: readonly ["date", "boolean", "select", "text"];
+/**
+ * One request field kind.
+ *
+ * @stability experimental
+ */
+export type ExportRequestFieldKind = (typeof EXPORT_REQUEST_FIELD_KINDS)[number];
+/**
+ * A source id (`user-data`) and a format id (`csv`): lowercase kebab-case.
+ * Both are PERMANENT once jobs carry them.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_ID_PATTERN: RegExp;
+/**
+ * A dataset name inside one export (`personal_access_token`): lowercase
+ * snake_case, so it is a safe file name in a zip and a safe JSON key.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_DATASET_PATTERN: RegExp;
+/**
+ * The download name a ready export may carry in its `Content-Disposition`:
+ * lowercase kebab-case plus one short extension. Anything else is refused
+ * before a URL is minted, so the header never needs quoting or escaping.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_FILE_NAME_PATTERN: RegExp;
+/**
+ * How many exports `GET /exports` lists: the caller's most recent.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_LIST_LIMIT = 20;
+/**
+ * The fixed message a failed export carries. The job's `lastError` is never
+ * shown: it may name a bucket, a table or a provider error.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_FAILED_MESSAGE = "The export could not be created. Please try again.";
+/**
+ * The JSON writer's `schemaVersion`. Bumped only on a breaking change of the
+ * envelope; a new field is additive and keeps it.
+ *
+ * @stability experimental
+ */
+export declare const EXPORT_JSON_SCHEMA_VERSION = 1;
+//# sourceMappingURL=constants.d.ts.map

package/dist/esm/exports/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/exports/constants.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,aAAa,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,qBAAqB,CAAC;AAEvD;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,+DAAgE,CAAC;AAE7F;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,aAAa,0BAA2B,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,8DAA+D,CAAC;AAEhG;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,MAAM,CAAC;AAEjD;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,gDAAiD,CAAC;AAEzF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,QAA2B,CAAC;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,QAA2B,CAAC;AAE/D;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,QAA8C,CAAC;AAEpF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,uDAAuD,CAAC;AAE1F;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,IAAI,CAAC"}

package/dist/esm/exports/constants.js

@@ -0,0 +1,106 @@
+// =============================================================================
+// The exports slice's zod-free constants (issue #744, PP-9.2)
+// =============================================================================
+//
+// Plain values and string-literal unions only (no zod), so a browser that needs
+// a constant or a type never bundles zod (test/no-zod-in-constants.test.ts).
+// =============================================================================
+/**
+ * The route group, relative to `/api`: `POST /exports`, `GET /exports`,
+ * `GET /exports/:id`.
+ *
+ * @stability experimental
+ */
+export const EXPORTS_PATH = '/exports';
+/**
+ * `GET /exports/sources`: the sources and formats the caller may use.
+ *
+ * @stability experimental
+ */
+export const EXPORTS_SOURCES_PATH = '/exports/sources';
+/**
+ * An export's derived status, in lifecycle order:
+ *
+ * - `pending`, `running`: the job's own status;
+ * - `ready`: the result is recorded, its file exists and it has not expired;
+ * - `expired`: the result is recorded but the file is gone or past its expiry;
+ * - `failed`: the job settled without a result.
+ *
+ * @stability experimental
+ */
+export const EXPORT_STATUSES = ['pending', 'running', 'ready', 'expired', 'failed'];
+/**
+ * Whose data a source exports: one user's (`user`) or one organization's (`org`).
+ *
+ * @stability experimental
+ */
+export const EXPORT_SCOPES = ['user', 'org'];
+/**
+ * A column's value type. `date` is a calendar day (`YYYY-MM-DD`), `datetime`
+ * an ISO 8601 instant; both travel as strings.
+ *
+ * @stability experimental
+ */
+export const EXPORT_COLUMN_TYPES = ['string', 'number', 'boolean', 'date', 'datetime'];
+/**
+ * The most keys one column's `meta` may carry.
+ *
+ * @stability experimental
+ */
+export const EXPORT_COLUMN_META_MAX_KEYS = 16;
+/**
+ * The longest `meta` key, and the longest `meta` string value, in characters.
+ *
+ * @stability experimental
+ */
+export const EXPORT_COLUMN_META_MAX_LENGTH = 256;
+/**
+ * The kind of one request field the export dialog draws: a date picker, a
+ * checkbox, a select or a text box.
+ *
+ * @stability experimental
+ */
+export const EXPORT_REQUEST_FIELD_KINDS = ['date', 'boolean', 'select', 'text'];
+/**
+ * A source id (`user-data`) and a format id (`csv`): lowercase kebab-case.
+ * Both are PERMANENT once jobs carry them.
+ *
+ * @stability experimental
+ */
+export const EXPORT_ID_PATTERN = /^[a-z][a-z0-9-]{0,47}$/;
+/**
+ * A dataset name inside one export (`personal_access_token`): lowercase
+ * snake_case, so it is a safe file name in a zip and a safe JSON key.
+ *
+ * @stability experimental
+ */
+export const EXPORT_DATASET_PATTERN = /^[a-z][a-z0-9_]{0,62}$/;
+/**
+ * The download name a ready export may carry in its `Content-Disposition`:
+ * lowercase kebab-case plus one short extension. Anything else is refused
+ * before a URL is minted, so the header never needs quoting or escaping.
+ *
+ * @stability experimental
+ */
+export const EXPORT_FILE_NAME_PATTERN = /^[a-z0-9][a-z0-9-]{0,127}\.[a-z0-9]{1,8}$/;
+/**
+ * How many exports `GET /exports` lists: the caller's most recent.
+ *
+ * @stability experimental
+ */
+export const EXPORT_LIST_LIMIT = 20;
+/**
+ * The fixed message a failed export carries. The job's `lastError` is never
+ * shown: it may name a bucket, a table or a provider error.
+ *
+ * @stability experimental
+ */
+export const EXPORT_FAILED_MESSAGE = 'The export could not be created. Please try again.';
+/**
+ * The JSON writer's `schemaVersion`. Bumped only on a breaking change of the
+ * envelope; a new field is additive and keeps it.
+ *
+ * @stability experimental
+ */
+export const EXPORT_JSON_SCHEMA_VERSION = 1;
+//# sourceMappingURL=constants.js.map

package/dist/esm/exports/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/exports/constants.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,8DAA8D;AAC9D,gFAAgF;AAChF,EAAE;AACF,gFAAgF;AAChF,6EAA6E;AAC7E,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,UAAU,CAAC;AAEvC;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,kBAAkB,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAC;AAS7F;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,KAAK,CAAU,CAAC;AAStD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,CAAU,CAAC;AAShG;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAE9C;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,GAAG,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AASzF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,wBAAwB,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,wBAAwB,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,2CAA2C,CAAC;AAEpF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,oDAAoD,CAAC;AAE1F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC"}

package/dist/esm/exports/index.d.ts

@@ -0,0 +1,5 @@
+export { EXPORTS_PATH, EXPORTS_SOURCES_PATH, EXPORT_COLUMN_META_MAX_KEYS, EXPORT_COLUMN_META_MAX_LENGTH, EXPORT_COLUMN_TYPES, EXPORT_DATASET_PATTERN, EXPORT_FAILED_MESSAGE, EXPORT_FILE_NAME_PATTERN, EXPORT_ID_PATTERN, EXPORT_JSON_SCHEMA_VERSION, EXPORT_LIST_LIMIT, EXPORT_REQUEST_FIELD_KINDS, EXPORT_SCOPES, EXPORT_STATUSES, } from './constants.js';
+export type { ExportColumnType, ExportRequestFieldKind, ExportScope, ExportStatus } from './constants.js';
+export { createExportSchema, exportCellSchema, exportColumnMetaSchema, exportColumnSchema, exportColumnTypeSchema, exportDownloadSchema, exportFormatDescriptorSchema, exportJsonDatasetSchema, exportJsonFileSchema, exportListResponseSchema, exportRequestFieldKindSchema, exportRequestFieldOptionSchema, exportRequestFieldSchema, exportSchema, exportScopeSchema, exportSourceDescriptorSchema, exportSourcesResponseSchema, exportStatusSchema, } from './schemas.js';
+export type { CreateExport, CreateExportInput, ExportCell, ExportColumn, ExportColumnMeta, ExportColumnTypeEnum, ExportDownload, ExportFormatDescriptor, ExportJsonDataset, ExportJsonFile, ExportListResponse, ExportRequestField, ExportRequestFieldKindEnum, ExportScopeEnum, ExportSourceDescriptor, ExportSourcesResponse, ExportStatusEnum, ExportView, } from './schemas.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/exports/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/exports/index.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,mBAAmB,EACnB,sBAAsB,EACtB,qBAAqB,EACrB,wBAAwB,EACxB,iBAAiB,EACjB,0BAA0B,EAC1B,iBAAiB,EACjB,0BAA0B,EAC1B,aAAa,EACb,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC1G,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACpB,4BAA4B,EAC5B,uBAAuB,EACvB,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,EAC5B,8BAA8B,EAC9B,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,EACjB,4BAA4B,EAC5B,2BAA2B,EAC3B,kBAAkB,GACnB,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,YAAY,EACZ,iBAAiB,EACjB,UAAU,EACV,YAAY,EACZ,gBAAgB,EAChB,oBAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,gBAAgB,EAChB,UAAU,GACX,MAAM,cAAc,CAAC"}

package/dist/esm/exports/index.js

@@ -0,0 +1,7 @@
+// `@marinoscar/platform-contract/exports`: the exports slice's wire shapes
+// (issue #744, PP-9.2): `/api/exports` (sources, create, list, get), the cell,
+// column and request-field shapes a source declares, and the JSON writer's
+// file envelope. Documented in ./README.md. Explicit named exports only.
+export { EXPORTS_PATH, EXPORTS_SOURCES_PATH, EXPORT_COLUMN_META_MAX_KEYS, EXPORT_COLUMN_META_MAX_LENGTH, EXPORT_COLUMN_TYPES, EXPORT_DATASET_PATTERN, EXPORT_FAILED_MESSAGE, EXPORT_FILE_NAME_PATTERN, EXPORT_ID_PATTERN, EXPORT_JSON_SCHEMA_VERSION, EXPORT_LIST_LIMIT, EXPORT_REQUEST_FIELD_KINDS, EXPORT_SCOPES, EXPORT_STATUSES, } from './constants.js';
+export { createExportSchema, exportCellSchema, exportColumnMetaSchema, exportColumnSchema, exportColumnTypeSchema, exportDownloadSchema, exportFormatDescriptorSchema, exportJsonDatasetSchema, exportJsonFileSchema, exportListResponseSchema, exportRequestFieldKindSchema, exportRequestFieldOptionSchema, exportRequestFieldSchema, exportSchema, exportScopeSchema, exportSourceDescriptorSchema, exportSourcesResponseSchema, exportStatusSchema, } from './schemas.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/exports/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/exports/index.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,+EAA+E;AAC/E,2EAA2E;AAC3E,yEAAyE;AAEzE,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,mBAAmB,EACnB,sBAAsB,EACtB,qBAAqB,EACrB,wBAAwB,EACxB,iBAAiB,EACjB,0BAA0B,EAC1B,iBAAiB,EACjB,0BAA0B,EAC1B,aAAa,EACb,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACpB,4BAA4B,EAC5B,uBAAuB,EACvB,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,EAC5B,8BAA8B,EAC9B,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,EACjB,4BAA4B,EAC5B,2BAA2B,EAC3B,kBAAkB,GACnB,MAAM,cAAc,CAAC"}

package/dist/esm/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/esm/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"}