@ourofoundation/ouro-js 3.7.8 → 3.8.0

package/dist/schema/files.d.cts

@@ -1,5 +1,13 @@
 import { z } from 'zod';
 
+declare const ZipArchiveMetadataSchema: z.ZodObject<{
+    entry_count: z.ZodNumber;
+    file_count: z.ZodNumber;
+    directory_count: z.ZodNumber;
+    total_uncompressed_size: z.ZodNumber;
+    total_compressed_size: z.ZodNumber;
+    preview_truncated: z.ZodBoolean;
+}, z.core.$strip>;
 declare const FileSchema: z.ZodObject<{
     id: z.ZodUUID;
     user_id: z.ZodUUID;
@@ -243,14 +251,14 @@ declare const FileSchema: z.ZodObject<{
     preview: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>>>>;
     state: z.ZodEnum<{
         success: "success";
-        error: "error";
         queued: "queued";
         "in-progress": "in-progress";
         "timed-out": "timed-out";
+        error: "error";
     }>;
     source: z.ZodEnum<{
-        web: "web";
         api: "api";
+        web: "web";
     }>;
     is_pinned_in_team: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
     created_at: z.ZodString;
@@ -269,21 +277,29 @@ declare const FileSchema: z.ZodObject<{
         size: z.ZodNumber;
         width: z.ZodOptional<z.ZodNumber>;
         height: z.ZodOptional<z.ZodNumber>;
+        archive: z.ZodOptional<z.ZodObject<{
+            entry_count: z.ZodNumber;
+            file_count: z.ZodNumber;
+            directory_count: z.ZodNumber;
+            total_uncompressed_size: z.ZodNumber;
+            total_compressed_size: z.ZodNumber;
+            preview_truncated: z.ZodBoolean;
+        }, z.core.$strip>>;
         source: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
         reply_to_comment_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
-    monetization: z.ZodOptional<z.ZodEnum<{
-        none: "none";
-        "pay-to-unlock": "pay-to-unlock";
-        "pay-per-use": "pay-per-use";
-    }>>;
     parent: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
     description: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodObject<{
         json: z.ZodRecord<z.ZodString, z.ZodAny>;
         text: z.ZodString;
     }, z.core.$strip>>>>;
+    monetization: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        "pay-to-unlock": "pay-to-unlock";
+        "pay-per-use": "pay-per-use";
+    }>>;
     parent_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodUUID>>>;
     license_id: z.ZodOptional<z.ZodString>;
     price: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
@@ -307,8 +323,8 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
     name: z.ZodString;
     name_url_slug: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     source: z.ZodDefault<z.ZodEnum<{
-        web: "web";
         api: "api";
+        web: "web";
     }>>;
     visibility: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
         organization: "organization";
@@ -399,20 +415,28 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
         size: z.ZodNumber;
         width: z.ZodOptional<z.ZodNumber>;
         height: z.ZodOptional<z.ZodNumber>;
+        archive: z.ZodOptional<z.ZodObject<{
+            entry_count: z.ZodNumber;
+            file_count: z.ZodNumber;
+            directory_count: z.ZodNumber;
+            total_uncompressed_size: z.ZodNumber;
+            total_compressed_size: z.ZodNumber;
+            preview_truncated: z.ZodBoolean;
+        }, z.core.$strip>>;
         source: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
         reply_to_comment_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
     }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
-    monetization: z.ZodOptional<z.ZodEnum<{
-        none: "none";
-        "pay-to-unlock": "pay-to-unlock";
-        "pay-per-use": "pay-per-use";
-    }>>;
     parent: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
     description: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodObject<{
         json: z.ZodRecord<z.ZodString, z.ZodAny>;
         text: z.ZodString;
     }, z.core.$strip>>>>;
+    monetization: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        "pay-to-unlock": "pay-to-unlock";
+        "pay-per-use": "pay-per-use";
+    }>>;
     parent_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodUUID>>>;
     license_id: z.ZodOptional<z.ZodString>;
     price: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
@@ -436,8 +460,8 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
     name: z.ZodString;
     name_url_slug: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     source: z.ZodDefault<z.ZodEnum<{
-        web: "web";
         api: "api";
+        web: "web";
     }>>;
     visibility: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
         organization: "organization";
@@ -525,7 +549,7 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
     team_id: string | null;
     org_id: string | null;
     name: string;
-    source: "web" | "api";
+    source: "api" | "web";
     visibility: "organization" | "public" | "private" | "monetized" | "inherit";
     attribution: {
         originality: "original" | "derivative" | "third-party";
@@ -560,15 +584,23 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
         size: number;
         width?: number | undefined;
         height?: number | undefined;
+        archive?: {
+            entry_count: number;
+            file_count: number;
+            directory_count: number;
+            total_uncompressed_size: number;
+            total_compressed_size: number;
+            preview_truncated: boolean;
+        } | undefined;
         source?: string | null | undefined;
         reply_to_comment_id?: string | null | undefined;
     };
-    monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     parent?: Record<string, any> | undefined;
     description?: {
         json: Record<string, any>;
         text: string;
     } | null | undefined;
+    monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     parent_id?: string | null | undefined;
     license_id?: string | undefined;
     price?: number | null | undefined;
@@ -586,7 +618,7 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
     team_id: string | null;
     org_id: string | null;
     name: string;
-    source: "web" | "api";
+    source: "api" | "web";
     visibility: "organization" | "public" | "private" | "monetized" | "inherit";
     attribution: {
         originality: "original" | "derivative" | "third-party";
@@ -616,12 +648,12 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
         source?: string | null | undefined;
         reply_to_comment_id?: string | null | undefined;
     };
-    monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     parent?: Record<string, any> | undefined;
     description?: {
         json: Record<string, any>;
         text: string;
     } | null | undefined;
+    monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     parent_id?: string | null | undefined;
     license_id?: string | undefined;
     price?: number | null | undefined;
@@ -639,7 +671,7 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
     team_id: string | null;
     org_id: string | null;
     name: string;
-    source: "web" | "api";
+    source: "api" | "web";
     visibility: "organization" | "public" | "private" | "monetized" | "inherit";
     attribution: {
         originality: "original" | "derivative" | "third-party";
@@ -674,15 +706,23 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
         size: number;
         width?: number | undefined;
         height?: number | undefined;
+        archive?: {
+            entry_count: number;
+            file_count: number;
+            directory_count: number;
+            total_uncompressed_size: number;
+            total_compressed_size: number;
+            preview_truncated: boolean;
+        } | undefined;
         source?: string | null | undefined;
         reply_to_comment_id?: string | null | undefined;
     };
-    monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     parent?: Record<string, any> | undefined;
     description?: {
         json: Record<string, any>;
         text: string;
     } | null | undefined;
+    monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     parent_id?: string | null | undefined;
     license_id?: string | undefined;
     price?: number | null | undefined;
@@ -700,7 +740,7 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
     team_id: string | null;
     org_id: string | null;
     name: string;
-    source: "web" | "api";
+    source: "api" | "web";
     visibility: "organization" | "public" | "private" | "monetized" | "inherit";
     attribution: {
         originality: "original" | "derivative" | "third-party";
@@ -730,12 +770,12 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
         source?: string | null | undefined;
         reply_to_comment_id?: string | null | undefined;
     };
-    monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     parent?: Record<string, any> | undefined;
     description?: {
         json: Record<string, any>;
         text: string;
     } | null | undefined;
+    monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     parent_id?: string | null | undefined;
     license_id?: string | undefined;
     price?: number | null | undefined;
@@ -751,6 +791,34 @@ declare const CreateFileSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
 }>>;
 declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
     asset_type: z.ZodOptional<z.ZodDefault<z.ZodLiteral<"file">>>;
+    org_id: z.ZodOptional<z.ZodUUID>;
+    parent: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    metadata: z.ZodOptional<z.ZodObject<{
+        id: z.ZodUUID;
+        path: z.ZodString;
+        bucket: z.ZodEnum<{
+            "public-files": "public-files";
+            files: "files";
+        }>;
+        name: z.ZodString;
+        type: z.ZodString;
+        extension: z.ZodString;
+        size: z.ZodNumber;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+        archive: z.ZodOptional<z.ZodObject<{
+            entry_count: z.ZodNumber;
+            file_count: z.ZodNumber;
+            directory_count: z.ZodNumber;
+            total_uncompressed_size: z.ZodNumber;
+            total_compressed_size: z.ZodNumber;
+            preview_truncated: z.ZodBoolean;
+        }, z.core.$strip>>;
+        source: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        reply_to_comment_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    }, z.core.$strip>>;
+    name: z.ZodOptional<z.ZodString>;
+    team_id: z.ZodOptional<z.ZodUUID>;
     visibility: z.ZodOptional<z.ZodEnum<{
         organization: "organization";
         public: "public";
@@ -758,6 +826,14 @@ declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
         monetized: "monetized";
         inherit: "inherit";
     }>>;
+    description: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        json: z.ZodRecord<z.ZodString, z.ZodAny>;
+        text: z.ZodString;
+    }, z.core.$strip>>>>;
+    source: z.ZodOptional<z.ZodEnum<{
+        api: "api";
+        web: "web";
+    }>>;
     monetization: z.ZodOptional<z.ZodEnum<{
         none: "none";
         "pay-to-unlock": "pay-to-unlock";
@@ -794,23 +870,11 @@ declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
     }, z.core.$strip>>;
     state: z.ZodOptional<z.ZodEnum<{
         success: "success";
-        error: "error";
         queued: "queued";
         "in-progress": "in-progress";
         "timed-out": "timed-out";
+        error: "error";
     }>>;
-    source: z.ZodOptional<z.ZodEnum<{
-        web: "web";
-        api: "api";
-    }>>;
-    parent: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
-    name: z.ZodOptional<z.ZodString>;
-    org_id: z.ZodOptional<z.ZodUUID>;
-    team_id: z.ZodOptional<z.ZodUUID>;
-    description: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        json: z.ZodRecord<z.ZodString, z.ZodAny>;
-        text: z.ZodString;
-    }, z.core.$strip>>>>;
     parent_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodUUID>>>;
     license_id: z.ZodOptional<z.ZodString>;
     license: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
@@ -829,28 +893,42 @@ declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
     stripe_product_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
     stripe_price_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
     stripe_meter_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
-    metadata: z.ZodOptional<z.ZodObject<{
-        id: z.ZodUUID;
-        path: z.ZodString;
-        bucket: z.ZodEnum<{
-            "public-files": "public-files";
-            files: "files";
-        }>;
-        name: z.ZodString;
-        type: z.ZodString;
-        extension: z.ZodString;
-        size: z.ZodNumber;
-        width: z.ZodOptional<z.ZodNumber>;
-        height: z.ZodOptional<z.ZodNumber>;
-        source: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
-        reply_to_comment_id: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
-    }, z.core.$strip>>;
     preview: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>>>>>;
     last_updated: z.ZodDefault<z.ZodString>;
 }, z.core.$strip>, z.ZodTransform<{
     last_updated: string;
     asset_type?: "file" | undefined;
+    org_id?: string | undefined;
+    parent?: Record<string, any> | undefined;
+    metadata?: {
+        id: string;
+        path: string;
+        bucket: "public-files" | "files";
+        name: string;
+        type: string;
+        extension: string;
+        size: number;
+        width?: number | undefined;
+        height?: number | undefined;
+        archive?: {
+            entry_count: number;
+            file_count: number;
+            directory_count: number;
+            total_uncompressed_size: number;
+            total_compressed_size: number;
+            preview_truncated: boolean;
+        } | undefined;
+        source?: string | null | undefined;
+        reply_to_comment_id?: string | null | undefined;
+    } | undefined;
+    name?: string | undefined;
+    team_id?: string | undefined;
     visibility?: "organization" | "public" | "private" | "monetized" | "inherit" | undefined;
+    description?: {
+        json: Record<string, any>;
+        text: string;
+    } | null | undefined;
+    source?: "api" | "web" | undefined;
     monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     attribution?: {
         originality: "original" | "derivative" | "third-party";
@@ -871,16 +949,7 @@ declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
         relation_type?: "IsSupplementTo" | "IsDerivedFrom" | "References" | "IsVariantFormOf" | "IsIdenticalTo" | null | undefined;
         doi?: string | null | undefined;
     } | undefined;
-    state?: "success" | "error" | "queued" | "in-progress" | "timed-out" | undefined;
-    source?: "web" | "api" | undefined;
-    parent?: Record<string, any> | undefined;
-    name?: string | undefined;
-    org_id?: string | undefined;
-    team_id?: string | undefined;
-    description?: {
-        json: Record<string, any>;
-        text: string;
-    } | null | undefined;
+    state?: "success" | "queued" | "in-progress" | "timed-out" | "error" | undefined;
     parent_id?: string | null | undefined;
     license_id?: string | undefined;
     license?: Record<string, any> | undefined;
@@ -893,6 +962,12 @@ declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
     stripe_product_id?: string | null | undefined;
     stripe_price_id?: string | null | undefined;
     stripe_meter_id?: string | null | undefined;
+    preview?: Record<string, any>[] | null | undefined;
+}, {
+    last_updated: string;
+    asset_type?: "file" | undefined;
+    org_id?: string | undefined;
+    parent?: Record<string, any> | undefined;
     metadata?: {
         id: string;
         path: string;
@@ -903,14 +978,25 @@ declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
         size: number;
         width?: number | undefined;
         height?: number | undefined;
+        archive?: {
+            entry_count: number;
+            file_count: number;
+            directory_count: number;
+            total_uncompressed_size: number;
+            total_compressed_size: number;
+            preview_truncated: boolean;
+        } | undefined;
         source?: string | null | undefined;
         reply_to_comment_id?: string | null | undefined;
     } | undefined;
-    preview?: Record<string, any>[] | null | undefined;
-}, {
-    last_updated: string;
-    asset_type?: "file" | undefined;
+    name?: string | undefined;
+    team_id?: string | undefined;
     visibility?: "organization" | "public" | "private" | "monetized" | "inherit" | undefined;
+    description?: {
+        json: Record<string, any>;
+        text: string;
+    } | null | undefined;
+    source?: "api" | "web" | undefined;
     monetization?: "none" | "pay-to-unlock" | "pay-per-use" | undefined;
     attribution?: {
         originality: "original" | "derivative" | "third-party";
@@ -931,16 +1017,7 @@ declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
         relation_type?: "IsSupplementTo" | "IsDerivedFrom" | "References" | "IsVariantFormOf" | "IsIdenticalTo" | null | undefined;
         doi?: string | null | undefined;
     } | undefined;
-    state?: "success" | "error" | "queued" | "in-progress" | "timed-out" | undefined;
-    source?: "web" | "api" | undefined;
-    parent?: Record<string, any> | undefined;
-    name?: string | undefined;
-    org_id?: string | undefined;
-    team_id?: string | undefined;
-    description?: {
-        json: Record<string, any>;
-        text: string;
-    } | null | undefined;
+    state?: "success" | "queued" | "in-progress" | "timed-out" | "error" | undefined;
     parent_id?: string | null | undefined;
     license_id?: string | undefined;
     license?: Record<string, any> | undefined;
@@ -953,24 +1030,12 @@ declare const updateFileSchema: z.ZodPipe<z.ZodObject<{
     stripe_product_id?: string | null | undefined;
     stripe_price_id?: string | null | undefined;
     stripe_meter_id?: string | null | undefined;
-    metadata?: {
-        id: string;
-        path: string;
-        bucket: "public-files" | "files";
-        name: string;
-        type: string;
-        extension: string;
-        size: number;
-        width?: number | undefined;
-        height?: number | undefined;
-        source?: string | null | undefined;
-        reply_to_comment_id?: string | null | undefined;
-    } | undefined;
     preview?: Record<string, any>[] | null | undefined;
 }>>;
 
 type File = z.infer<typeof FileSchema>;
 type CreateFile = z.infer<typeof CreateFileSchema>;
 type UpdateFile = z.infer<typeof updateFileSchema>;
+type ZipArchiveMetadata = z.infer<typeof ZipArchiveMetadataSchema>;
 
-export { type CreateFile, CreateFileSchema, type File, FileSchema, type UpdateFile, updateFileSchema };
+export { type CreateFile, CreateFileSchema, type File, FileSchema, type UpdateFile, type ZipArchiveMetadata, ZipArchiveMetadataSchema, updateFileSchema };