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

package/dist/esm/user-data/schemas.d.ts

@@ -0,0 +1,306 @@
+import { z } from 'zod';
+import { OFFBOARDING_USER_DISPOSITIONS, USER_DATA_JOB_STATUSES, USER_DATA_SCOPE_LAYERS } from './constants.js';
+/**
+ * The entries of the scope-layer enum.
+ *
+ * @stability experimental
+ */
+export type UserDataScopeLayerEnum = {
+    [K in (typeof USER_DATA_SCOPE_LAYERS)[number]]: K;
+};
+/**
+ * The entries of the job-status enum.
+ *
+ * @stability experimental
+ */
+export type UserDataJobStatusEnum = {
+    [K in (typeof USER_DATA_JOB_STATUSES)[number]]: K;
+};
+/**
+ * The entries of the user-disposition enum.
+ *
+ * @stability experimental
+ */
+export type OffboardingUserDispositionEnum = {
+    [K in (typeof OFFBOARDING_USER_DISPOSITIONS)[number]]: K;
+};
+/**
+ * A scope layer (`specific` or `danger`).
+ *
+ * @stability experimental
+ */
+export declare const userDataScopeLayerSchema: z.ZodEnum<UserDataScopeLayerEnum>;
+/**
+ * A job status as the status routes report it.
+ *
+ * @stability experimental
+ */
+export declare const userDataJobStatusSchema: z.ZodEnum<UserDataJobStatusEnum>;
+/**
+ * One category in `GET /api/user-data/summary`: what the caller owns in it.
+ *
+ * @stability experimental
+ */
+export declare const userDataCategorySummarySchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodString;
+    content: z.ZodBoolean;
+    count: z.ZodNumber;
+    bytes: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * One scope in `GET /api/user-data/summary`.
+ *
+ * @stability experimental
+ */
+export declare const userDataScopeSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodString;
+    layer: z.ZodEnum<UserDataScopeLayerEnum>;
+    confirmation: z.ZodString;
+    categories: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * `GET /api/user-data/summary`.
+ *
+ * @stability experimental
+ */
+export declare const userDataSummarySchema: z.ZodObject<{
+    categories: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodString;
+        content: z.ZodBoolean;
+        count: z.ZodNumber;
+        bytes: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    scopes: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodString;
+        layer: z.ZodEnum<UserDataScopeLayerEnum>;
+        confirmation: z.ZodString;
+        categories: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+    kept: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * `POST /api/user-data/deletions` body. The phrase is re-checked against the
+ * scope's own (`400` `CONFIRMATION_MISMATCH`); an unknown scope is a `400`
+ * `UNKNOWN_SCOPE`.
+ *
+ * @stability experimental
+ */
+export declare const userDataDeletionRequestSchema: z.ZodObject<{
+    scope: z.ZodString;
+    confirmation: z.ZodString;
+}, z.core.$strip>;
+/**
+ * The `202` of every request route: the job (a new one, or the one already
+ * in flight).
+ *
+ * @stability experimental
+ */
+export declare const userDataJobStartedSchema: z.ZodObject<{
+    jobId: z.ZodString;
+    status: z.ZodEnum<UserDataJobStatusEnum>;
+}, z.core.$strip>;
+/**
+ * What a finished per-user deletion did. Written by the job on
+ * `payload.result`. Every map defaults to `{}`, so an older result still parses.
+ *
+ * @stability experimental
+ */
+export declare const userDataPurgeResultSchema: z.ZodObject<{
+    categories: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    models: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    storageObjectsDeleted: z.ZodDefault<z.ZodNumber>;
+    storageObjectsFailed: z.ZodDefault<z.ZodNumber>;
+    cancelledJobs: z.ZodDefault<z.ZodNumber>;
+    delegatedJobs: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * `GET /api/user-data/deletions/:jobId`.
+ *
+ * @stability experimental
+ */
+export declare const userDataDeletionStatusSchema: z.ZodObject<{
+    jobId: z.ZodString;
+    status: z.ZodEnum<UserDataJobStatusEnum>;
+    scope: z.ZodString;
+    result: z.ZodNullable<z.ZodObject<{
+        categories: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+        models: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+        storageObjectsDeleted: z.ZodDefault<z.ZodNumber>;
+        storageObjectsFailed: z.ZodDefault<z.ZodNumber>;
+        cancelledJobs: z.ZodDefault<z.ZodNumber>;
+        delegatedJobs: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    error: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * `POST /api/admin/factory-reset` body: the exact phrase or a `400`.
+ *
+ * @stability experimental
+ */
+export declare const factoryResetRequestSchema: z.ZodObject<{
+    confirmation: z.ZodLiteral<"FACTORY RESET">;
+}, z.core.$strip>;
+/**
+ * `GET /api/admin/factory-reset/summary`: deployment-wide counts of what a
+ * factory reset deletes, and whether it is available.
+ *
+ * @stability experimental
+ */
+export declare const factoryResetSummarySchema: z.ZodObject<{
+    disabledReason: z.ZodNullable<z.ZodString>;
+    otherUsers: z.ZodNumber;
+    organizations: z.ZodNumber;
+    storageObjects: z.ZodNumber;
+    jobs: z.ZodNumber;
+    categories: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+    deleted: z.ZodArray<z.ZodString>;
+    kept: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * What a finished factory reset did, on `payload.result`: flat counts, keyed
+ * `users`, `jobs`, `workerNodesReassigned`, `workerNodesRemoved`,
+ * `organizations`, `storageObjectsDeleted`, `storageObjectsFailed`,
+ * `category.<id>` and `step.<stepId>.<key>`.
+ *
+ * @stability experimental
+ */
+export declare const factoryResetResultSchema: z.ZodObject<{
+    counts: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+}, z.core.$strip>;
+/**
+ * `GET /api/admin/factory-reset/:jobId`.
+ *
+ * @stability experimental
+ */
+export declare const factoryResetStatusSchema: z.ZodObject<{
+    jobId: z.ZodString;
+    status: z.ZodEnum<UserDataJobStatusEnum>;
+    result: z.ZodNullable<z.ZodObject<{
+        counts: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    }, z.core.$strip>>;
+    error: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * A user disposition (`keep` or `purge`).
+ *
+ * @stability experimental
+ */
+export declare const offboardingUserDispositionSchema: z.ZodEnum<OffboardingUserDispositionEnum>;
+/**
+ * `POST /api/admin/orgs/:orgId/offboarding` body. `confirmation` must be the
+ * organization's slug; `skipExport.reason` skips every failing precondition
+ * and is recorded in the audit event.
+ *
+ * @stability experimental
+ */
+export declare const orgOffboardingRequestSchema: z.ZodObject<{
+    confirmation: z.ZodString;
+    userDisposition: z.ZodDefault<z.ZodEnum<OffboardingUserDispositionEnum>>;
+    skipExport: z.ZodOptional<z.ZodObject<{
+        reason: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * One precondition's verdict in the offboarding summary (and in a `409`).
+ *
+ * @stability experimental
+ */
+export declare const offboardingPreconditionResultSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    passed: z.ZodBoolean;
+    message: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * `GET /api/admin/orgs/:orgId/offboarding/summary`.
+ *
+ * @stability experimental
+ */
+export declare const orgOffboardingSummarySchema: z.ZodObject<{
+    org: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodString;
+        isDefault: z.ZodBoolean;
+    }, z.core.$strip>;
+    blockedReason: z.ZodNullable<z.ZodString>;
+    models: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    members: z.ZodNumber;
+    invites: z.ZodNumber;
+    storageObjects: z.ZodNumber;
+    usersLeftWithoutOrg: z.ZodNumber;
+    preconditions: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        passed: z.ZodBoolean;
+        message: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * What a finished offboarding did, on `payload.result`: flat counts keyed by
+ * model name plus `jobs`, `memberships`, `invites`, `storageObjectsDeleted`,
+ * `storageObjectsFailed`, `usersKept`, `usersPurged` and `organizations`.
+ *
+ * @stability experimental
+ */
+export declare const orgOffboardingResultSchema: z.ZodObject<{
+    counts: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+}, z.core.$strip>;
+/**
+ * `GET /api/admin/orgs/:orgId/offboarding/:jobId`.
+ *
+ * @stability experimental
+ */
+export declare const orgOffboardingStatusSchema: z.ZodObject<{
+    jobId: z.ZodString;
+    status: z.ZodEnum<UserDataJobStatusEnum>;
+    result: z.ZodNullable<z.ZodObject<{
+        counts: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    }, z.core.$strip>>;
+    error: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/** @stability experimental */
+export type UserDataCategorySummary = z.infer<typeof userDataCategorySummarySchema>;
+/** @stability experimental */
+export type UserDataScope = z.infer<typeof userDataScopeSchema>;
+/** @stability experimental */
+export type UserDataSummary = z.infer<typeof userDataSummarySchema>;
+/** @stability experimental */
+export type UserDataDeletionRequest = z.infer<typeof userDataDeletionRequestSchema>;
+/** @stability experimental */
+export type UserDataJobStarted = z.infer<typeof userDataJobStartedSchema>;
+/** @stability experimental */
+export type UserDataPurgeResult = z.infer<typeof userDataPurgeResultSchema>;
+/** @stability experimental */
+export type UserDataDeletionStatus = z.infer<typeof userDataDeletionStatusSchema>;
+/** @stability experimental */
+export type FactoryResetRequest = z.infer<typeof factoryResetRequestSchema>;
+/** @stability experimental */
+export type FactoryResetSummary = z.infer<typeof factoryResetSummarySchema>;
+/** @stability experimental */
+export type FactoryResetResult = z.infer<typeof factoryResetResultSchema>;
+/** @stability experimental */
+export type FactoryResetStatus = z.infer<typeof factoryResetStatusSchema>;
+/** @stability experimental */
+export type OrgOffboardingRequest = z.input<typeof orgOffboardingRequestSchema>;
+/** @stability experimental */
+export type OffboardingPreconditionResult = z.infer<typeof offboardingPreconditionResultSchema>;
+/** @stability experimental */
+export type OrgOffboardingSummary = z.infer<typeof orgOffboardingSummarySchema>;
+/** @stability experimental */
+export type OrgOffboardingResult = z.infer<typeof orgOffboardingResultSchema>;
+/** @stability experimental */
+export type OrgOffboardingStatus = z.infer<typeof orgOffboardingStatusSchema>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/esm/user-data/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/user-data/schemas.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAEL,6BAA6B,EAC7B,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AAExB;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AAC3F;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AAC1F;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AAK1G;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAkC,CAAC;AAE1G;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAkC,CAAC;AAExG;;;;GAIG;AACH,eAAO,MAAM,6BAA6B;;;;;;;iBAaxC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;iBAa9B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;iBAWhC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;iBAKxC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;iBAKnC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;;;;;iBAapC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;iBAWvC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;iBAKpC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;iBAiCpC,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;iBAGnC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;;;;iBASnC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAEtF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B;;;;;;iBAYtC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,mCAAmC;;;;;iBAS9C,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;iBA0BtC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;iBAGrC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,0BAA0B;;;;;;;iBASrC,CAAC;AAEH,8BAA8B;AAC9B,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AACpF,8BAA8B;AAC9B,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,8BAA8B;AAC9B,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,8BAA8B;AAC9B,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AACpF,8BAA8B;AAC9B,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,8BAA8B;AAC9B,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,8BAA8B;AAC9B,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAClF,8BAA8B;AAC9B,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,8BAA8B;AAC9B,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,8BAA8B;AAC9B,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,8BAA8B;AAC9B,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,8BAA8B;AAC9B,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,8BAA8B;AAC9B,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAChG,8BAA8B;AAC9B,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,8BAA8B;AAC9B,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,8BAA8B;AAC9B,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}

package/dist/esm/user-data/schemas.js

@@ -0,0 +1,330 @@
+// =============================================================================
+// The user-data slice's wire shapes (issue #743, PP-9.1)
+// =============================================================================
+//
+// The routes of the per-user deletion (`/api/user-data/*`), the admin factory
+// reset (`/api/admin/factory-reset/*`) and organization offboarding
+// (`/api/admin/orgs/:orgId/offboarding/*`). Shared by
+// `@marinoscar/platform-api/user-data` (which wraps them as DTOs, so the
+// OpenAPI document is generated from them) and
+// `@marinoscar/platform-web/user-data`.
+//
+// Categories and scopes are REGISTRIES, so their ids are strings here, never
+// enums: an app adds its own. Count maps are keyed by category id (or model
+// name) for the same reason.
+//
+// The deletion body's `confirmation` is a plain string on the wire: the API
+// re-checks it against the scope's exact phrase with a zod literal built from
+// the scope registry (a wrong phrase is a 400), because the phrase depends on
+// the scope chosen. The factory reset's phrase is fixed, so it IS a literal
+// here.
+// =============================================================================
+import { z } from 'zod';
+import { FACTORY_RESET_CONFIRMATION, OFFBOARDING_USER_DISPOSITIONS, USER_DATA_JOB_STATUSES, USER_DATA_SCOPE_LAYERS, } from './constants.js';
+const count = z.number().int().nonnegative();
+const counts = z.record(z.string(), count);
+/**
+ * A scope layer (`specific` or `danger`).
+ *
+ * @stability experimental
+ */
+export const userDataScopeLayerSchema = z.enum(USER_DATA_SCOPE_LAYERS);
+/**
+ * A job status as the status routes report it.
+ *
+ * @stability experimental
+ */
+export const userDataJobStatusSchema = z.enum(USER_DATA_JOB_STATUSES);
+/**
+ * One category in `GET /api/user-data/summary`: what the caller owns in it.
+ *
+ * @stability experimental
+ */
+export const userDataCategorySummarySchema = z.object({
+    /** The registered category id (`files`, `notifications`, an app's own). */
+    id: z.string(),
+    /** Shown in the UI. */
+    label: z.string(),
+    /** One sentence. */
+    description: z.string(),
+    /** Whether the built-in `content` scope includes it. */
+    content: z.boolean(),
+    /** Rows the caller owns in the category's models. */
+    count,
+    /** Stored bytes, when the category knows them (`files`); `null` otherwise. */
+    bytes: count.nullable(),
+});
+/**
+ * One scope in `GET /api/user-data/summary`.
+ *
+ * @stability experimental
+ */
+export const userDataScopeSchema = z.object({
+    /** The scope id the deletion request names. Permanent once a job carried it. */
+    id: z.string(),
+    /** Shown in the UI. */
+    label: z.string(),
+    /** One sentence. */
+    description: z.string(),
+    /** Which layer of the Danger Zone renders it. */
+    layer: userDataScopeLayerSchema,
+    /** The exact phrase the request must carry. */
+    confirmation: z.string(),
+    /** The category ids it deletes, resolved (never `'all'` or `'content'`). */
+    categories: z.array(z.string()),
+});
+/**
+ * `GET /api/user-data/summary`.
+ *
+ * @stability experimental
+ */
+export const userDataSummarySchema = z.object({
+    /** Per category. */
+    categories: z.array(userDataCategorySummarySchema),
+    /** Every scope the caller may request. */
+    scopes: z.array(userDataScopeSchema),
+    /**
+     * What every deletion keeps, as lines for the Danger Zone's "Always kept"
+     * list: the platform's own lines, then one per registered kept model that
+     * carries a `summary`.
+     */
+    kept: z.array(z.string()),
+});
+/**
+ * `POST /api/user-data/deletions` body. The phrase is re-checked against the
+ * scope's own (`400` `CONFIRMATION_MISMATCH`); an unknown scope is a `400`
+ * `UNKNOWN_SCOPE`.
+ *
+ * @stability experimental
+ */
+export const userDataDeletionRequestSchema = z.object({
+    /** The scope id. */
+    scope: z.string().min(1).max(64),
+    /** The exact phrase. */
+    confirmation: z.string().max(200),
+});
+/**
+ * The `202` of every request route: the job (a new one, or the one already
+ * in flight).
+ *
+ * @stability experimental
+ */
+export const userDataJobStartedSchema = z.object({
+    /** The job. */
+    jobId: z.string(),
+    /** The job status. */
+    status: userDataJobStatusSchema,
+});
+/**
+ * What a finished per-user deletion did. Written by the job on
+ * `payload.result`. Every map defaults to `{}`, so an older result still parses.
+ *
+ * @stability experimental
+ */
+export const userDataPurgeResultSchema = z.object({
+    /** Rows deleted per category id. */
+    categories: counts.default({}),
+    /** Rows deleted per model name. */
+    models: counts.default({}),
+    /** Objects whose bytes and row were deleted. */
+    storageObjectsDeleted: count.default(0),
+    /** Objects the provider refused; their rows were kept (a later deletion retries them). */
+    storageObjectsFailed: count.default(0),
+    /** Pending jobs whose subject was a deleted row. */
+    cancelledJobs: count.default(0),
+    /** Jobs enqueued for categories delegated to another purge job. */
+    delegatedJobs: count.default(0),
+});
+/**
+ * `GET /api/user-data/deletions/:jobId`.
+ *
+ * @stability experimental
+ */
+export const userDataDeletionStatusSchema = z.object({
+    /** The job. */
+    jobId: z.string(),
+    /** The job status. */
+    status: userDataJobStatusSchema,
+    /** The scope id. */
+    scope: z.string(),
+    /** The result, once succeeded (`null` otherwise). */
+    result: userDataPurgeResultSchema.nullable(),
+    /** The failure, once failed (`null` otherwise). */
+    error: z.string().nullable(),
+});
+/**
+ * `POST /api/admin/factory-reset` body: the exact phrase or a `400`.
+ *
+ * @stability experimental
+ */
+export const factoryResetRequestSchema = z.object({
+    /** The exact phrase. */
+    confirmation: z.literal(FACTORY_RESET_CONFIRMATION, {
+        error: `Type exactly "${FACTORY_RESET_CONFIRMATION}" to confirm`,
+    }),
+});
+/**
+ * `GET /api/admin/factory-reset/summary`: deployment-wide counts of what a
+ * factory reset deletes, and whether it is available.
+ *
+ * @stability experimental
+ */
+export const factoryResetSummarySchema = z.object({
+    /** `null` when available; otherwise the error code the request route answers with. */
+    disabledReason: z.string().nullable(),
+    /** Every user except the caller. */
+    otherUsers: count,
+    /** Organizations other than the default one (multi-organization mode). */
+    organizations: count,
+    /** Storage objects that do not survive (outside every `survivesFactoryReset` prefix). */
+    storageObjects: count,
+    /** Pending and finished job rows that are not linked to a backup. */
+    jobs: count,
+    /** Rows per user-data category, across every user. */
+    categories: z.array(z.object({
+        /** The category id. */
+        id: z.string(),
+        /** Its label. */
+        label: z.string(),
+        /** Rows across every user. */
+        count,
+    })),
+    /**
+     * What the reset deletes, as lines for the page's "Deleted" list: the
+     * platform's own lines, then one per registered factory reset step that
+     * carries a `summary`.
+     */
+    deleted: z.array(z.string()),
+    /**
+     * What the reset keeps, as lines for the page's "Kept" list: the platform's
+     * own lines, then one per registered kept model that carries a `summary`.
+     */
+    kept: z.array(z.string()),
+});
+/**
+ * What a finished factory reset did, on `payload.result`: flat counts, keyed
+ * `users`, `jobs`, `workerNodesReassigned`, `workerNodesRemoved`,
+ * `organizations`, `storageObjectsDeleted`, `storageObjectsFailed`,
+ * `category.<id>` and `step.<stepId>.<key>`.
+ *
+ * @stability experimental
+ */
+export const factoryResetResultSchema = z.object({
+    /** Flat counts (see the schema). */
+    counts: counts.default({}),
+});
+/**
+ * `GET /api/admin/factory-reset/:jobId`.
+ *
+ * @stability experimental
+ */
+export const factoryResetStatusSchema = z.object({
+    /** The job. */
+    jobId: z.string(),
+    /** The job status. */
+    status: userDataJobStatusSchema,
+    /** The result, once succeeded (`null` otherwise). */
+    result: factoryResetResultSchema.nullable(),
+    /** The failure, once failed (`null` otherwise). */
+    error: z.string().nullable(),
+});
+/**
+ * A user disposition (`keep` or `purge`).
+ *
+ * @stability experimental
+ */
+export const offboardingUserDispositionSchema = z.enum(OFFBOARDING_USER_DISPOSITIONS);
+/**
+ * `POST /api/admin/orgs/:orgId/offboarding` body. `confirmation` must be the
+ * organization's slug; `skipExport.reason` skips every failing precondition
+ * and is recorded in the audit event.
+ *
+ * @stability experimental
+ */
+export const orgOffboardingRequestSchema = z.object({
+    /** The exact phrase. */
+    confirmation: z.string().max(200),
+    /** What happens to members left without an organization. */
+    userDisposition: offboardingUserDispositionSchema.default('keep'),
+    /** Skip every failing precondition, with a reason. */
+    skipExport: z
+        .object({
+        /** Why, recorded in the audit event. */
+        reason: z.string().trim().min(3).max(500),
+    })
+        .optional(),
+});
+/**
+ * One precondition's verdict in the offboarding summary (and in a `409`).
+ *
+ * @stability experimental
+ */
+export const offboardingPreconditionResultSchema = z.object({
+    /** The id. */
+    id: z.string(),
+    /** Shown in the UI. */
+    label: z.string(),
+    /** Whether it passed. */
+    passed: z.boolean(),
+    /** Why not, or `null`. */
+    message: z.string().nullable(),
+});
+/**
+ * `GET /api/admin/orgs/:orgId/offboarding/summary`.
+ *
+ * @stability experimental
+ */
+export const orgOffboardingSummarySchema = z.object({
+    /** The organization. */
+    org: z.object({
+        /** Its id. */
+        id: z.string(),
+        /** Its name. */
+        name: z.string(),
+        /** Its slug: the confirmation phrase. */
+        slug: z.string(),
+        /** Whether it is the default organization (never offboarded). */
+        isDefault: z.boolean(),
+    }),
+    /** `null` when offboarding is possible; otherwise the error code the request answers with. */
+    blockedReason: z.string().nullable(),
+    /** Org-owned rows per model. */
+    models: counts,
+    /** Its memberships. */
+    members: count,
+    /** Its invitations. */
+    invites: count,
+    /** Stored files that go. */
+    storageObjects: count,
+    /** Members with no other membership: the users `userDisposition` decides about. */
+    usersLeftWithoutOrg: count,
+    /** Every registered precondition with its verdict. */
+    preconditions: z.array(offboardingPreconditionResultSchema),
+});
+/**
+ * What a finished offboarding did, on `payload.result`: flat counts keyed by
+ * model name plus `jobs`, `memberships`, `invites`, `storageObjectsDeleted`,
+ * `storageObjectsFailed`, `usersKept`, `usersPurged` and `organizations`.
+ *
+ * @stability experimental
+ */
+export const orgOffboardingResultSchema = z.object({
+    /** Flat counts (see the schema). */
+    counts: counts.default({}),
+});
+/**
+ * `GET /api/admin/orgs/:orgId/offboarding/:jobId`.
+ *
+ * @stability experimental
+ */
+export const orgOffboardingStatusSchema = z.object({
+    /** The job. */
+    jobId: z.string(),
+    /** The job status. */
+    status: userDataJobStatusSchema,
+    /** The result, once succeeded (`null` otherwise). */
+    result: orgOffboardingResultSchema.nullable(),
+    /** The failure, once failed (`null` otherwise). */
+    error: z.string().nullable(),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/esm/user-data/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/user-data/schemas.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,yDAAyD;AACzD,gFAAgF;AAChF,EAAE;AACF,8EAA8E;AAC9E,oEAAoE;AACpE,sDAAsD;AACtD,yEAAyE;AACzE,+CAA+C;AAC/C,wCAAwC;AACxC,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,6BAA6B;AAC7B,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,8EAA8E;AAC9E,4EAA4E;AAC5E,QAAQ;AACR,gFAAgF;AAEhF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,0BAA0B,EAC1B,6BAA6B,EAC7B,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,gBAAgB,CAAC;AAqBxB,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;AAC7C,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAsC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;AAE1G;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAqC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;AAExG;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,2EAA2E;IAC3E,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,uBAAuB;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,oBAAoB;IACpB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,wDAAwD;IACxD,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,qDAAqD;IACrD,KAAK;IACL,8EAA8E;IAC9E,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;CACxB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,gFAAgF;IAChF,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,uBAAuB;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,oBAAoB;IACpB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,iDAAiD;IACjD,KAAK,EAAE,wBAAwB;IAC/B,+CAA+C;IAC/C,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,4EAA4E;IAC5E,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAChC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,oBAAoB;IACpB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC;IAClD,0CAA0C;IAC1C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;IACpC;;;;OAIG;IACH,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC1B,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,oBAAoB;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IAChC,wBAAwB;IACxB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;CAClC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,eAAe;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,sBAAsB;IACtB,MAAM,EAAE,uBAAuB;CAChC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9B,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAC1B,gDAAgD;IAChD,qBAAqB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACvC,0FAA0F;IAC1F,oBAAoB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACtC,oDAAoD;IACpD,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/B,mEAAmE;IACnE,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;CAChC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,eAAe;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,sBAAsB;IACtB,MAAM,EAAE,uBAAuB;IAC/B,oBAAoB;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,qDAAqD;IACrD,MAAM,EAAE,yBAAyB,CAAC,QAAQ,EAAE;IAC5C,mDAAmD;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,wBAAwB;IACxB,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,EAAE;QAClD,KAAK,EAAE,iBAAiB,0BAA0B,cAAc;KACjE,CAAC;CACH,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,sFAAsF;IACtF,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,oCAAoC;IACpC,UAAU,EAAE,KAAK;IACjB,0EAA0E;IAC1E,aAAa,EAAE,KAAK;IACpB,yFAAyF;IACzF,cAAc,EAAE,KAAK;IACrB,qEAAqE;IACrE,IAAI,EAAE,KAAK;IACX,sDAAsD;IACtD,UAAU,EAAE,CAAC,CAAC,KAAK,CACjB,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,iBAAiB;QACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,8BAA8B;QAC9B,KAAK;KACN,CAAC,CACH;IACD;;;;OAIG;IACH,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC1B,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;CAC3B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,eAAe;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,sBAAsB;IACtB,MAAM,EAAE,uBAAuB;IAC/B,qDAAqD;IACrD,MAAM,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IAC3C,mDAAmD;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAA8C,CAAC,CAAC,IAAI,CAC/F,6BAA6B,CAC9B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,wBAAwB;IACxB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IACjC,4DAA4D;IAC5D,eAAe,EAAE,gCAAgC,CAAC,OAAO,CAAC,MAAM,CAAC;IACjE,sDAAsD;IACtD,UAAU,EAAE,CAAC;SACV,MAAM,CAAC;QACN,wCAAwC;QACxC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;KAC1C,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1D,cAAc;IACd,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,uBAAuB;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,yBAAyB;IACzB,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,0BAA0B;IAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,wBAAwB;IACxB,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,cAAc;QACd,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,gBAAgB;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,yCAAyC;QACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,iEAAiE;QACjE,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;KACvB,CAAC;IACF,8FAA8F;IAC9F,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,gCAAgC;IAChC,MAAM,EAAE,MAAM;IACd,uBAAuB;IACvB,OAAO,EAAE,KAAK;IACd,uBAAuB;IACvB,OAAO,EAAE,KAAK;IACd,4BAA4B;IAC5B,cAAc,EAAE,KAAK;IACrB,mFAAmF;IACnF,mBAAmB,EAAE,KAAK;IAC1B,sDAAsD;IACtD,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,mCAAmC,CAAC;CAC5D,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;CAC3B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,eAAe;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,sBAAsB;IACtB,MAAM,EAAE,uBAAuB;IAC/B,qDAAqD;IACrD,MAAM,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC7C,mDAAmD;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC"}