@stackbit/cms-core 1.0.2-develop.2 → 1.0.3-develop.1

package/src/content-store.ts

@@ -81,6 +81,7 @@ import {
 } from './utils/user-log-utils';
 import { ContentEngine, PluginRef, contentEngine } from 'content-engine';
 import { mapDocumentVersionsToApiDocumentVersions } from './utils/csi-to-api-docs-converter';
+import { NoopFileCache, FileCache } from './utils/file-cache';
 
 export type HandleConfigAssets = <T extends Model>({ models, presets }: { models?: T[]; presets?: PresetMap }) => Promise<{ models: T[]; presets: PresetMap }>;
 
@@ -749,6 +750,12 @@ export class ContentStore {
             return contentSourceData;
         };
 
+        const fileCache = this.localDev
+            ? new FileCache({
+                  dirPath: this.stackbitConfig!.dirPath,
+                  keyPrefix: `${contentSourceId}/src.`
+              })
+            : new NoopFileCache();
         const cache: CSITypes.Cache = {
             getSchema: () => {
                 const contentSourceData = getContentSourceDataForCurrentInstance('getSchema');
@@ -846,6 +853,28 @@ export class ContentStore {
                     contentSourceId: contentSourceId
                 });
                 await this.processContentStoreEvents();
+            },
+
+            get: async (key) => {
+                const contentSourceData = getContentSourceDataForCurrentInstance('get');
+                if (!contentSourceData) {
+                    return;
+                }
+                return fileCache.get(key);
+            },
+            set: async (key, value) => {
+                const contentSourceData = getContentSourceDataForCurrentInstance('set');
+                if (!contentSourceData) {
+                    return;
+                }
+                return fileCache.set(key, value);
+            },
+            remove: async (key) => {
+                const contentSourceData = getContentSourceDataForCurrentInstance('remove');
+                if (!contentSourceData) {
+                    return;
+                }
+                return fileCache.remove(key);
             }
         };
 

package/src/utils/file-cache.ts

@@ -0,0 +1,66 @@
+import path from 'path';
+import * as fse from 'fs-extra';
+
+export interface FileCacheInterface {
+    get(key: string): Promise<unknown>;
+    set(key: string, value: unknown): Promise<void>;
+    remove(key: string): Promise<void>;
+}
+
+export class FileCache implements FileCacheInterface {
+    private readonly dirPath: string;
+    private readonly keyPrefix: string;
+    constructor({ dirPath, keyPrefix }: { dirPath: string; keyPrefix?: string }) {
+        this.dirPath = dirPath;
+        this.keyPrefix = keyPrefix ?? '';
+    }
+    async get(key: string): Promise<unknown> {
+        const fileName = this.filePathKey(key);
+        try {
+            const exists = await fse.pathExists(fileName);
+            if (!exists) {
+                return;
+            }
+            return fse.readJson(fileName);
+        } catch (error) {
+            return;
+        }
+    }
+    async set(key: string, value: unknown): Promise<void> {
+        const fileName = this.filePathKey(key);
+        try {
+            return fse.outputJson(fileName, value);
+        } catch (error) {
+            return;
+        }
+    }
+    async remove(key: string): Promise<void> {
+        const fileName = this.filePathKey(key);
+        try {
+            return await fse.remove(fileName);
+        } catch (error) {
+            return;
+        }
+    }
+
+    private filePathKey(key: string) {
+        return path.join(this.dirPath, '.stackbit/cache', `${this.keyPrefix}${key}.json`);
+    }
+}
+
+/**
+ * This no-op file cache is used to replace FileCache when Stackbit runs in Cloud.
+ */
+export class NoopFileCache implements FileCacheInterface {
+    async get(): Promise<unknown> {
+        return;
+    }
+
+    async set(): Promise<void> {
+        return;
+    }
+
+    async remove(): Promise<void> {
+        return;
+    }
+}

package/dist/utils/custom-search-filters.d.ts

@@ -1,12 +0,0 @@
-import * as ContentStoreTypes from '../types';
-import { SearchFilterItem } from '../types';
-import { ScheduledAction } from '@stackbit/types';
-import { SchemaForSearch } from './search-utils';
-declare type CustomFilterMethod = (filter: SearchFilterItem, document: ContentStoreTypes.Document, opts: {
-    locale?: string;
-    schema: SchemaForSearch;
-    activeScheduledActionsByDocumentId: Record<string, ScheduledAction[]>;
-}) => boolean;
-export declare const CUSTOM_FILTERS: Record<string, CustomFilterMethod>;
-export {};
-//# sourceMappingURL=custom-search-filters.d.ts.map

package/dist/utils/custom-search-filters.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"custom-search-filters.d.ts","sourceRoot":"","sources":["../../src/utils/custom-search-filters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,iBAAiB,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAqB,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAiE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEhH,aAAK,kBAAkB,GAAG,CACtB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,EACpC,IAAI,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,eAAe,CAAC;IAAC,kCAAkC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC,CAAA;CAAE,KACxH,OAAO,CAAC;AAEb,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAwC7D,CAAC"}

package/dist/utils/custom-search-filters.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CUSTOM_FILTERS = void 0;
-const search_utils_1 = require("./search-utils");
-exports.CUSTOM_FILTERS = {
-    hasSchedules: (filter, document, opts) => {
-        var _a;
-        const field = {
-            type: 'boolean',
-            value: !!((_a = opts.activeScheduledActionsByDocumentId[document.srcObjectId]) === null || _a === void 0 ? void 0 : _a.length)
-        };
-        return (0, search_utils_1.isBooleanFieldMatches)({ field, filter, locale: opts.locale });
-    },
-    scheduledActionId: (filter, document, opts) => {
-        var _a, _b;
-        const field = {
-            type: 'list',
-            items: (_b = (_a = opts.activeScheduledActionsByDocumentId[document.srcObjectId]) === null || _a === void 0 ? void 0 : _a.map((scheduledAction) => ({
-                type: 'string',
-                value: scheduledAction.id
-            }))) !== null && _b !== void 0 ? _b : []
-        };
-        const model = {
-            type: 'object',
-            name: '',
-            fields: [
-                {
-                    name: '',
-                    type: 'list',
-                    items: {
-                        type: 'string'
-                    }
-                }
-            ]
-        };
-        return (0, search_utils_1.isListFieldMatches)({ field, filter, model, locale: opts.locale, document });
-    },
-    scheduledActionDate: (filter, document, opts) => {
-        var _a, _b;
-        return ((_b = (_a = opts.activeScheduledActionsByDocumentId[document.srcObjectId]) === null || _a === void 0 ? void 0 : _a.some((scheduledAction) => {
-            const field = { type: 'date', value: scheduledAction.executeAt };
-            return (0, search_utils_1.isDateFieldMatches)({ field, filter, locale: opts.locale });
-        })) !== null && _b !== void 0 ? _b : false);
-    }
-};
-//# sourceMappingURL=custom-search-filters.js.map

package/dist/utils/custom-search-filters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"custom-search-filters.js","sourceRoot":"","sources":["../../src/utils/custom-search-filters.ts"],"names":[],"mappings":";;;AAIA,iDAAgH;AAQnG,QAAA,cAAc,GAAuC;IAC9D,YAAY,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;;QACrC,MAAM,KAAK,GAAG;YACV,IAAI,EAAE,SAAkB;YACxB,KAAK,EAAE,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,WAAW,CAAC,0CAAE,MAAM,CAAA;SACjF,CAAC;QACF,OAAO,IAAA,oCAAqB,EAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,iBAAiB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;;QAC1C,MAAM,KAAK,GAAsB;YAC7B,IAAI,EAAE,MAAM;YACZ,KAAK,EACD,MAAA,MAAA,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,WAAW,CAAC,0CAAE,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;gBACrF,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,eAAe,CAAC,EAAE;aAC5B,CAAC,CAAC,mCAAI,EAAE;SAChB,CAAC;QACF,MAAM,KAAK,GAAU;YACjB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,EAAE;YACR,MAAM,EAAE;gBACJ;oBACI,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;qBACjB;iBACJ;aACJ;SACJ,CAAC;QACF,OAAO,IAAA,iCAAkB,EAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACvF,CAAC;IACD,mBAAmB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;;QAC5C,OAAO,CACH,MAAA,MAAA,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,WAAW,CAAC,0CAAE,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;YACpF,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,MAAe,EAAE,KAAK,EAAE,eAAe,CAAC,SAAS,EAAE,CAAC;YAC1E,OAAO,IAAA,iCAAkB,EAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACtE,CAAC,CAAC,mCAAI,KAAK,CACd,CAAC;IACN,CAAC;CACJ,CAAC"}