Skip to content

TypeScript API / laikacms/catalog / CatalogSchema

Variable: CatalogSchema ​

ts
const CatalogSchema: StandardSchemaV1<{
  collections?: {
   [key: string]: 
     | {
     directory?: string;
     documentDescriptionKey?: string;
     documentStatusKey?: string;
     documentTitleKey?: string;
     format?: string;
     key: string;
     name?: string;
     recursive?: boolean;
     revisionDirectory?: string;
     type: "document";
     unpublishedStatuses?: {
      [key: string]: object;
     };
   }
     | {
     accept?: readonly string[];
     directory?: string;
     key: string;
     name?: string;
     pathFormat?: string;
     recursive?: boolean;
     type: "media";
     url?: string;
   };
  };
}, {
  collections?: {
   [key: string]: 
     | {
     directory?: string;
     documentDescriptionKey?: string;
     documentStatusKey?: string;
     documentTitleKey?: string;
     format?: string & Brand<"StorageFormat">;
     key: string;
     name?: string;
     recursive?: boolean;
     revisionDirectory?: string;
     type: "document";
     unpublishedStatuses?: {
      [key: string]: object;
     };
   }
     | {
     accept?: readonly string[];
     directory?: string;
     key: string;
     name?: string;
     pathFormat?: string;
     recursive?: boolean;
     type: "media";
     url?: string;
   };
  };
}> & Struct<{
  collections: optional<$Record<String, Union<readonly [StandardSchemaV1<{
     directory?: ... | ...;
     documentDescriptionKey?: ... | ...;
     documentStatusKey?: ... | ...;
     documentTitleKey?: ... | ...;
     format?: ... | ...;
     key: string;
     name?: ... | ...;
     recursive?: ... | ... | ...;
     revisionDirectory?: ... | ...;
     type: "document";
     unpublishedStatuses?: ... | ...;
   }, {
     directory?: ... | ...;
     documentDescriptionKey?: ... | ...;
     documentStatusKey?: ... | ...;
     documentTitleKey?: ... | ...;
     format?: ... | ...;
     key: string;
     name?: ... | ...;
     recursive?: ... | ... | ...;
     revisionDirectory?: ... | ...;
     type: "document";
     unpublishedStatuses?: ... | ...;
   }> & Struct<{
     directory: optional<...>;
     documentDescriptionKey: optional<...>;
     documentStatusKey: optional<...>;
     documentTitleKey: optional<...>;
     format: optional<...>;
     key: String;
     name: optional<...>;
     recursive: optional<...>;
     revisionDirectory: optional<...>;
     type: Literal<...>;
     unpublishedStatuses: optional<...>;
   }>, StandardSchemaV1<{
     accept?: ... | ...;
     directory?: ... | ...;
     key: string;
     name?: ... | ...;
     pathFormat?: ... | ...;
     recursive?: ... | ... | ...;
     type: "media";
     url?: ... | ...;
   }, {
     accept?: ... | ...;
     directory?: ... | ...;
     key: string;
     name?: ... | ...;
     pathFormat?: ... | ...;
     recursive?: ... | ... | ...;
     type: "media";
     url?: ... | ...;
   }> & Struct<{
     accept: optional<...>;
     directory: optional<...>;
     key: String;
     name: optional<...>;
     pathFormat: optional<...>;
     recursive: optional<...>;
     type: Literal<...>;
     url: optional<...>;
  }>]>>>;
}>;

Released under the MIT License.