@isardsat/editorial-common 6.3.3 → 6.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @isardsat/editorial-common
 
+## 6.4.0
+
+### Minor Changes
+
+- 34be523: Add large file handling
+
 ## 6.3.3
 
 ### Patch Changes

package/dist/schemas.d.ts

@@ -2,6 +2,10 @@ import { z } from "@hono/zod-openapi";
 export declare const EditorialConfigSchema: z.ZodObject<{
     name: z.ZodString;
     publicUrl: z.ZodString;
+    publicDir: z.ZodDefault<z.ZodString>;
+    publicDeletedDir: z.ZodDefault<z.ZodString>;
+    filesUrl: z.ZodString;
+    largeFilesUrl: z.ZodString;
     previewUrl: z.ZodOptional<z.ZodString>;
     silent: z.ZodOptional<z.ZodBoolean>;
     firebase: z.ZodOptional<z.ZodObject<{
@@ -32,6 +36,10 @@ export declare const EditorialConfigSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name: string;
     publicUrl: string;
+    publicDir: string;
+    publicDeletedDir: string;
+    filesUrl: string;
+    largeFilesUrl: string;
     previewUrl?: string | undefined;
     silent?: boolean | undefined;
     firebase?: {
@@ -46,6 +54,10 @@ export declare const EditorialConfigSchema: z.ZodObject<{
 }, {
     name: string;
     publicUrl: string;
+    filesUrl: string;
+    largeFilesUrl: string;
+    publicDir?: string | undefined;
+    publicDeletedDir?: string | undefined;
     previewUrl?: string | undefined;
     silent?: boolean | undefined;
     firebase?: {
@@ -230,17 +242,23 @@ export declare const BaseEditorialFileSchema: z.ZodObject<{
     name: z.ZodString;
     type: z.ZodEnum<["file", "directory"]>;
     path: z.ZodString;
+    relativePath: z.ZodString;
     size: z.ZodNumber;
+    isLarge: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     path: string;
     type: "file" | "directory";
+    relativePath: string;
     size: number;
+    isLarge?: boolean | undefined;
 }, {
     name: string;
     path: string;
     type: "file" | "directory";
+    relativePath: string;
     size: number;
+    isLarge?: boolean | undefined;
 }>;
 export type BaseEditorialFile = z.infer<typeof BaseEditorialFileSchema> & {
     children?: BaseEditorialFile[];

package/dist/schemas.js

@@ -5,6 +5,10 @@ const zod_openapi_1 = require("@hono/zod-openapi");
 exports.EditorialConfigSchema = zod_openapi_1.z.object({
     name: zod_openapi_1.z.string(),
     publicUrl: zod_openapi_1.z.string().url(),
+    publicDir: zod_openapi_1.z.string().default("public/files"),
+    publicDeletedDir: zod_openapi_1.z.string().default("public/files/.deleted"),
+    filesUrl: zod_openapi_1.z.string().url(),
+    largeFilesUrl: zod_openapi_1.z.string().url(),
     previewUrl: zod_openapi_1.z.string().optional(),
     silent: zod_openapi_1.z.boolean().optional(),
     firebase: zod_openapi_1.z
@@ -71,7 +75,9 @@ exports.BaseEditorialFileSchema = zod_openapi_1.z.object({
     name: zod_openapi_1.z.string(),
     type: zod_openapi_1.z.enum(["file", "directory"]),
     path: zod_openapi_1.z.string(),
+    relativePath: zod_openapi_1.z.string(),
     size: zod_openapi_1.z.number(),
+    isLarge: zod_openapi_1.z.boolean().optional(),
 });
 exports.EditorialFileSchema = exports.BaseEditorialFileSchema.extend({
     children: zod_openapi_1.z

package/dist/types.d.ts

@@ -1,5 +1,10 @@
-import type { z } from 'zod';
-import type { EditorialConfigSchema, EditorialDataItemSchema, EditorialDataObjectWithTypeSchema, EditorialDataSchema, EditorialDataTypeSchema, EditorialSchemaItemFieldSchema, EditorialSchemaItemSchema, EditorialSchemaSchema } from './schemas.js';
+import type { z } from "zod";
+import type { EditorialConfigSchema, EditorialDataItemSchema, EditorialDataObjectWithTypeSchema, EditorialDataSchema, EditorialDataTypeSchema, EditorialSchemaItemFieldSchema, EditorialSchemaItemSchema, EditorialSchemaSchema } from "./schemas.js";
+export interface LargeFileHandler {
+    list: () => Promise<object[]>;
+    delete: () => Promise<void>;
+    upload: () => Promise<void>;
+}
 export type EditorialConfig = z.infer<typeof EditorialConfigSchema>;
 export type EditorialData = z.infer<typeof EditorialDataSchema>;
 export type EditorialDataType = z.infer<typeof EditorialDataTypeSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isardsat/editorial-common",
-  "version": "6.3.3",
+  "version": "6.4.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {

package/src/schemas.ts

@@ -3,6 +3,10 @@ import { z } from "@hono/zod-openapi";
 export const EditorialConfigSchema = z.object({
   name: z.string(),
   publicUrl: z.string().url(),
+  publicDir: z.string().default("public/files"),
+  publicDeletedDir: z.string().default("public/files/.deleted"),
+  filesUrl: z.string().url(),
+  largeFilesUrl: z.string().url(),
   previewUrl: z.string().optional(),
   silent: z.boolean().optional(),
   firebase: z
@@ -87,7 +91,9 @@ export const BaseEditorialFileSchema = z.object({
   name: z.string(),
   type: z.enum(["file", "directory"]),
   path: z.string(),
+  relativePath: z.string(),
   size: z.number(),
+  isLarge: z.boolean().optional(),
 });
 
 export type BaseEditorialFile = z.infer<typeof BaseEditorialFileSchema> & {

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { z } from 'zod';
+import type { z } from "zod";
 import type {
   EditorialConfigSchema,
   EditorialDataItemSchema,
@@ -8,7 +8,13 @@ import type {
   EditorialSchemaItemFieldSchema,
   EditorialSchemaItemSchema,
   EditorialSchemaSchema,
-} from './schemas.js';
+} from "./schemas.js";
+
+export interface LargeFileHandler {
+  list: () => Promise<object[]>;
+  delete: () => Promise<void>;
+  upload: () => Promise<void>;
+}
 
 export type EditorialConfig = z.infer<typeof EditorialConfigSchema>;
 export type EditorialData = z.infer<typeof EditorialDataSchema>;