TypeScript API / contentia/catalog / CatalogProvider
Abstract Class: CatalogProvider
Source of truth for catalog configuration — collection settings, media settings, and per-collection JSON Schemas.
Cache-key stability invariant: for a given persisted catalog state, getDocumentCollectionSettings(collection).directory and getMediaCollectionSettings(collection).directory are pure, stable functions of the collection argument. Two provider instances pointed at the same underlying storage MUST return identical directory values for the same collection key — both within a single process and across rolling deploys.
This guarantee exists so consumers (e.g. CachedStorageRepository, webhook-invalidators) can safely derive cache keys from provider output without risking invalidation desync between replicas running different code versions.
Implementations that violate this invariant (e.g. by injecting a non-deterministic prefix) must document the deviation explicitly.
Extended by
Constructors
Constructor
new CatalogProvider(): CatalogProvider;Returns
CatalogProvider
Methods
getCatalog()
abstract getCatalog(): ContentiaTask<{
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;
};
};
}>;Returns
ContentiaTask<{ 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; }; }; }>
getCollectionSchema()
abstract getCollectionSchema(collection): ContentiaTask<JSONSchema7>;Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
ContentiaTask<JSONSchema7>
getDocumentCollectionSettings()
abstract getDocumentCollectionSettings(collection): ContentiaTask<{
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;
};
}>;Returns settings for a document collection. If the collection is not explicitly configured, a deterministic default derived solely from the collection key is returned (stable across instances — see class-level cache-key stability invariant).
Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
ContentiaTask<{ 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; }; }>
getMediaCollectionSettings()
abstract getMediaCollectionSettings(collection): ContentiaTask<{
accept?: readonly string[];
directory?: string;
key: string;
name?: string;
pathFormat?: string;
recursive?: boolean;
type: "media";
url?: string;
}>;Returns settings for a media collection. If the collection is not explicitly configured, a deterministic default derived solely from the collection key is returned (stable across instances — see class-level cache-key stability invariant).
Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
ContentiaTask<{ accept?: readonly string[]; directory?: string; key: string; name?: string; pathFormat?: string; recursive?: boolean; type: "media"; url?: string; }>
putCatalog()
abstract putCatalog(settings): ContentiaTask<void>;Parameters
| Parameter | Type |
|---|---|
settings | { 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; }; }; } |
settings.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; }; } |
Returns
ContentiaTask<void>
putCollectionSchema()
abstract putCollectionSchema(collection, schema): ContentiaTask<void>;Parameters
| Parameter | Type |
|---|---|
collection | string |
schema | JSONSchema7 |
Returns
ContentiaTask<void>
putDocumentCollectionSettings()
abstract putDocumentCollectionSettings(collection, settings): ContentiaTask<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
collection | string | - |
settings | { 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; }; } | - |
settings.directory? | string | - |
settings.documentDescriptionKey? | string | - |
settings.documentStatusKey? | string | - |
settings.documentTitleKey? | string | - |
settings.format? | string & Brand<"StorageFormat"> | - |
settings.key? | string | - |
settings.name? | string | - |
settings.recursive? | boolean | - |
settings.revisionDirectory? | string | Directory for storing revisions (version history) |
settings.type? | "document" | - |
settings.unpublishedStatuses? | { [key: string]: object; } | Map of unpublished status values to their configuration The key is the status value stored in the 'unpublished' document type's 'status' field Documents with these statuses are stored in .contentia/[collection]/[status.directory] |
Returns
ContentiaTask<void>
putMediaCollectionSettings()
abstract putMediaCollectionSettings(collection, settings): ContentiaTask<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
collection | string | - |
settings | { accept?: readonly string[]; directory?: string; key: string; name?: string; pathFormat?: string; recursive?: boolean; type: "media"; url?: string; } | - |
settings.accept? | readonly string[] | The files the collection accepts, written as in the HTML accept attribute: MIME types (image/png), wildcards (image/*), or file extensions (.png), matched against an asset's filename and key. Empty or left out accepts any file. |
settings.directory? | string | - |
settings.key? | string | - |
settings.name? | string | - |
settings.pathFormat? | string | - |
settings.recursive? | boolean | - |
settings.type? | "media" | - |
settings.url? | string | - |
Returns
ContentiaTask<void>