@stackbit/cms-core 0.0.17 → 0.0.19-alpha.1

package/src/{encoder.js → encoder.ts}

@@ -1,8 +1,34 @@
-const _ = require('lodash');
-const consts = require('./consts');
-const { mergeAtPath, omitByNil } = require('./utils');
+import _ from 'lodash';
+import * as consts from './consts';
+import { mergeAtPath, omitByNil } from './utils';
 
-function mapObjectFields({ data, model, fieldDataPath, fieldDataPathsInverted, fieldModelPath, encodeValue, delegate }) {
+export type FieldData = Record<string, FieldDataRootItem>;
+
+export interface FieldDataItem {
+    type: 'object';
+    srcObjectLabel: string;
+    srcModelName: string;
+    srcModelLabel: string;
+    fields: Record<string, any>;
+}
+
+export interface FieldDataRootItem extends Omit<FieldDataItem, 'type'> {
+    type: 'object' | 'image' | 'file';
+    srcType: string;
+    srcProjectId: string;
+    srcProjectUrl: string;
+    srcEnvironment: string;
+    srcObjectId: string;
+    srcObjectUrl: string;
+    isChanged: boolean;
+    status: 'modified' | 'added' | 'deleted' | 'published';
+    createdAt: string;
+    createdBy?: string;
+    updatedAt: string;
+    updatedBy?: string[];
+}
+
+function mapObjectFields({ data, model, fieldDataPath, fieldDataPathsInverted, fieldModelPath, encodeValue, delegate }: any): any {
     if (!fieldModelPath) {
         fieldModelPath = [model.name];
     }
@@ -26,7 +52,7 @@ function mapObjectFields({ data, model, fieldDataPath, fieldDataPathsInverted, f
                 return accum;
             }
 
-            let childFieldModelPath;
+            let childFieldModelPath: any;
             if (_.get(model, 'isList') && field.name === 'items') {
                 childFieldModelPath = fieldModelPath;
             } else {
@@ -35,7 +61,7 @@ function mapObjectFields({ data, model, fieldDataPath, fieldDataPathsInverted, f
 
             const fieldPath = ['fields', field.name];
 
-            const mapLocalizedField = (accum, localizedField) => {
+            const mapLocalizedField = (accum: any, localizedField: any): any => {
                 const localePath = fieldModel.localized ? ['locales', localizedField.locale] : [];
                 const fullFieldDataPath = _.concat(fieldPath, localePath);
 
@@ -81,7 +107,7 @@ function mapObjectFields({ data, model, fieldDataPath, fieldDataPathsInverted, f
     );
 }
 
-function mapField({ fieldValue, fieldModel, fieldDataPath, fieldModelPath, delegate }) {
+function mapField({ fieldValue, fieldModel, fieldDataPath, fieldModelPath, delegate }: any): any {
     if (_.includes(consts.SIMPLE_VALUE_FIELDS, fieldModel.type)) {
         return {
             fieldData: { value: fieldValue }
@@ -92,10 +118,10 @@ function mapField({ fieldValue, fieldModel, fieldDataPath, fieldModelPath, deleg
         };
     } else if (fieldModel.type === 'list') {
         const itemsModel = _.get(fieldModel, 'items');
-        let getListItemModel;
+        let getListItemModel: any;
         if (_.isArray(itemsModel)) {
             // in Sanity, list items may have multiple types, in this case, 'items' will be an array
-            getListItemModel = (listItem, fieldModel) => delegate.getItemTypeForListItem(listItem, fieldModel);
+            getListItemModel = (listItem: any, fieldModel: any) => delegate.getItemTypeForListItem(listItem, fieldModel);
         } else {
             // get the type of list items, if type is not defined, set string as it is the default
             const listItemsType = _.get(itemsModel, 'type', 'string');
@@ -124,7 +150,7 @@ function mapField({ fieldValue, fieldModel, fieldDataPath, fieldModelPath, deleg
                 };
             },
             {
-                fieldData: { items: [] }
+                fieldData: { items: [] as any[] }
             }
         );
     } else if (fieldModel.type === 'object') {
@@ -188,7 +214,7 @@ function mapField({ fieldValue, fieldModel, fieldDataPath, fieldModelPath, deleg
     }
 }
 
-function fieldModelToFieldData(fieldModel, overrides) {
+function fieldModelToFieldData(fieldModel: any, overrides?: any): any {
     const type = ['reference', 'model'].includes(fieldModel.type) ? 'object' : fieldModel.type;
     return omitByNil(
         _.assign(
@@ -224,7 +250,7 @@ function fieldModelToFieldData(fieldModel, overrides) {
     );
 }
 
-function getFieldModelNames(fieldModel) {
+function getFieldModelNames(fieldModel: any): any {
     const fieldType = fieldModel.type;
     if (fieldType === 'reference' || fieldType === 'model') {
         return _.clone(_.get(fieldModel, 'models', []));
@@ -256,7 +282,7 @@ function unsetObject() {
     };
 }
 
-function unresolvedReference(fieldValue, delegate) {
+function unresolvedReference(fieldValue: any, delegate: any) {
     return {
         fieldData: {
             type: 'unresolved_reference',
@@ -274,7 +300,7 @@ function unresolvedModel() {
     };
 }
 
-function mapData(data, prevEncodingResult, delegate) {
+function mapData(data: any, prevEncodingResult: any, delegate: any): any {
     // scan model instances and replace their 'data' with an identity-mapped data
     return _.reduce(
         data,
@@ -304,12 +330,24 @@ function mapData(data, prevEncodingResult, delegate) {
     );
 }
 
-function encodeData({ data, prevEncodingResult, delegate }) {
+export interface EncodingResult {
+    fieldData: FieldData;
+    encodedData?: any[];
+    hashedData?: Record<string, any>;
+    fieldDataPaths?: string[];
+}
+
+export interface EncodeDataOptions {
+    data: any[];
+    prevEncodingResult?: EncodingResult | null;
+    delegate: any;
+    encodeDelimiter: string;
+}
+
+export default function encodeData({ data, prevEncodingResult, delegate }: EncodeDataOptions): EncodingResult {
     data = _.cloneDeep(data);
     const mappedData = mapData(data, prevEncodingResult, delegate);
     return {
         fieldData: mappedData.fieldData
     };
 }
-
-module.exports = encodeData;

package/src/index.ts

@@ -0,0 +1,10 @@
+export * as stackbit from './stackbit';
+export * as annotator from './annotator';
+export * as utils from './utils';
+export * as consts from './consts';
+export * from './common/common-schema';
+export * from './content-store';
+export * as ContentSourceTypes from './content-source-interface';
+export * as ContentStoreTypes from './content-store-types';
+export { default as encodeData } from './encoder';
+export * from './encoder';

package/src/stackbit/{index.js → index.ts}

@@ -1,14 +1,10 @@
-const _ = require('lodash');
-const { loadConfig, isListDataModel } = require('@stackbit/sdk');
+import _ from 'lodash';
+import { loadConfig, isListDataModel, Config } from '@stackbit/sdk';
 
-module.exports = {
-    fetchAndConvertSchema
-};
-
-function fetchAndConvertSchema(options) {
+export function fetchAndConvertSchema(options: { dirPath: string }): Promise<{ schema: Config; errors: Error[] }> {
     return loadConfig({ dirPath: options.dirPath }).then(({ config, errors }) => {
         if (!config) {
-            return { schema: {}, errors };
+            return { schema: {} as Config, errors };
         }
         wrapListDataModels(config);
         const schema = _.pick(config, [
@@ -38,7 +34,7 @@ function fetchAndConvertSchema(options) {
     });
 }
 
-function wrapListDataModels(config) {
+function wrapListDataModels(config: Config) {
     _.forEach(config.models, (model) => {
         if (!isListDataModel(model)) {
             return;

package/src/utils/timer.ts

@@ -0,0 +1,42 @@
+import { Logger } from '../content-store-types';
+
+export class Timer {
+    private readonly timerCallback: () => void;
+    private readonly timerMs: number;
+    private readonly logger?: Logger;
+    private timeout: NodeJS.Timeout | null;
+
+    constructor({ timerCallback, timerMs = 30 * 60 * 1000, logger }: { timerCallback: () => void; timerMs?: number; logger?: Logger }) {
+        this.timerCallback = timerCallback;
+        this.timerMs = timerMs;
+        this.logger = logger?.createLogger({ label: 'timer' });
+        this.timeout = null;
+        this.handleTimeout = this.handleTimeout.bind(this);
+    }
+
+    isRunning() {
+        return !!this.timeout;
+    }
+
+    startTimer() {
+        this.resetTimer();
+    }
+
+    resetTimer() {
+        this.stopTimer();
+        this.timeout = setTimeout(this.handleTimeout, this.timerMs);
+    }
+
+    stopTimer() {
+        if (this.timeout) {
+            clearTimeout(this.timeout);
+            this.timeout = null;
+        }
+    }
+
+    handleTimeout() {
+        this.logger?.debug('timer reached');
+        this.timeout = null;
+        this.timerCallback();
+    }
+}

package/dist/utils/lazy-poller.d.ts

@@ -1,21 +0,0 @@
-export interface LazyPollerOptions<T> {
-    notificationCallback: T;
-    sleepTimeoutMs?: number;
-    pollingIntervalMs?: number;
-    logger: any;
-}
-export declare abstract class LazyPoller<T> {
-    protected notificationCallback: T;
-    private readonly sleepTimeoutMs;
-    private readonly pollingIntervalMs;
-    private sleepTimeout;
-    private pollTimeout;
-    private isSleeping;
-    private logger;
-    protected constructor({ notificationCallback, sleepTimeoutMs, pollingIntervalMs, logger }: LazyPollerOptions<T>);
-    resetSleepTimer(): void;
-    sleep(): void;
-    private setPollTimeout;
-    private callPoll;
-    protected abstract poll(notificationCallback: T): any;
-}

package/dist/utils/lazy-poller.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LazyPoller = void 0;
-class LazyPoller {
-    constructor({ notificationCallback, sleepTimeoutMs = 30 * 60 * 1000, pollingIntervalMs = 1000, logger }) {
-        this.notificationCallback = notificationCallback;
-        this.sleepTimeoutMs = sleepTimeoutMs;
-        this.pollingIntervalMs = pollingIntervalMs;
-        this.logger = logger;
-        this.sleepTimeout = null;
-        this.pollTimeout = null;
-        this.isSleeping = true;
-        this.sleep = this.sleep.bind(this);
-        this.callPoll = this.callPoll.bind(this);
-    }
-    resetSleepTimer() {
-        if (this.sleepTimeout) {
-            clearTimeout(this.sleepTimeout);
-        }
-        this.sleepTimeout = setTimeout(this.sleep, this.sleepTimeoutMs);
-        if (this.isSleeping) {
-            this.logger.debug('start polling');
-            this.isSleeping = false;
-            this.setPollTimeout();
-        }
-    }
-    sleep() {
-        this.logger.debug('sleep');
-        if (this.sleepTimeout) {
-            clearTimeout(this.sleepTimeout);
-            this.sleepTimeout = null;
-        }
-        this.isSleeping = true;
-        if (this.pollTimeout) {
-            clearTimeout(this.pollTimeout);
-            this.pollTimeout = null;
-        }
-    }
-    setPollTimeout() {
-        this.pollTimeout = setTimeout(this.callPoll, this.pollingIntervalMs);
-    }
-    async callPoll() {
-        this.pollTimeout = null;
-        return Promise.resolve(this.poll(this.notificationCallback))
-            .catch(error => {
-            this.logger.error('error in pollCallback', { error: error.message });
-        })
-            .finally(() => {
-            if (!this.isSleeping) {
-                this.setPollTimeout();
-            }
-        });
-    }
-}
-exports.LazyPoller = LazyPoller;
-//# sourceMappingURL=lazy-poller.js.map

package/dist/utils/lazy-poller.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"lazy-poller.js","sourceRoot":"","sources":["../../src/utils/lazy-poller.ts"],"names":[],"mappings":";;;AASA,MAAsB,UAAU;IAS5B,YAAsB,EAAE,oBAAoB,EAAE,cAAc,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,iBAAiB,GAAG,IAAI,EAAE,MAAM,EAAwB;QACnI,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,eAAe;QACX,IAAI,IAAI,CAAC,YAAY,EAAE;YACnB,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,cAAc,EAAE,CAAC;SACzB;IACL,CAAC;IAED,KAAK;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,IAAI,IAAI,CAAC,YAAY,EAAE;YACnB,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAChC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;SAC5B;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;SAC3B;IACL,CAAC;IAEO,cAAc;QAClB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACzE,CAAC;IAEO,KAAK,CAAC,QAAQ;QAClB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;aACvD,KAAK,CAAC,KAAK,CAAC,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACzE,CAAC,CAAC;aACD,OAAO,CAAC,GAAG,EAAE;YACV,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;gBAClB,IAAI,CAAC,cAAc,EAAE,CAAC;aACzB;QACL,CAAC,CAAC,CAAC;IACX,CAAC;CAGJ;AAhED,gCAgEC"}

package/src/common/common-schema.js

@@ -1,14 +0,0 @@
-const IMAGE_MODEL = {
-    type: 'image',
-    name: '__image_model',
-    label: 'Image',
-    labelField: 'title',
-    fields: [
-        {name: 'title', type: 'string'},
-        {name: 'url', type: 'string'}
-    ]
-};
-
-module.exports = {
-    IMAGE_MODEL
-}

package/src/index.js

@@ -1,13 +0,0 @@
-const encodeData = require('./encoder');
-const stackbit = require('./stackbit');
-const annotator = require('./annotator');
-const utils = require('./utils');
-const consts = require('./consts');
-
-module.exports = {
-    utils,
-    consts,
-    annotator,
-    encodeData,
-    stackbit
-};

package/src/utils/lazy-poller.ts

@@ -1,74 +0,0 @@
-
-
-export interface LazyPollerOptions<T> {
-    notificationCallback: T;
-    sleepTimeoutMs?: number;
-    pollingIntervalMs?: number;
-    logger: any;
-}
-
-export abstract class LazyPoller<T> {
-    protected notificationCallback: T;
-    private readonly sleepTimeoutMs: number;
-    private readonly pollingIntervalMs: number;
-    private sleepTimeout: null | ReturnType<typeof setTimeout>;
-    private pollTimeout: null | ReturnType<typeof setTimeout>;
-    private isSleeping: boolean;
-    private logger: any;
-
-    protected constructor({ notificationCallback, sleepTimeoutMs = 30 * 60 * 1000, pollingIntervalMs = 1000, logger }: LazyPollerOptions<T>) {
-        this.notificationCallback = notificationCallback;
-        this.sleepTimeoutMs = sleepTimeoutMs;
-        this.pollingIntervalMs = pollingIntervalMs;
-        this.logger = logger;
-        this.sleepTimeout = null;
-        this.pollTimeout = null;
-        this.isSleeping = true;
-        this.sleep = this.sleep.bind(this);
-        this.callPoll = this.callPoll.bind(this);
-    }
-
-    resetSleepTimer() {
-        if (this.sleepTimeout) {
-            clearTimeout(this.sleepTimeout);
-        }
-        this.sleepTimeout = setTimeout(this.sleep, this.sleepTimeoutMs);
-        if (this.isSleeping) {
-            this.logger.debug('start polling');
-            this.isSleeping = false;
-            this.setPollTimeout();
-        }
-    }
-
-    sleep() {
-        this.logger.debug('sleep');
-        if (this.sleepTimeout) {
-            clearTimeout(this.sleepTimeout);
-            this.sleepTimeout = null;
-        }
-        this.isSleeping = true;
-        if (this.pollTimeout) {
-            clearTimeout(this.pollTimeout);
-            this.pollTimeout = null;
-        }
-    }
-
-    private setPollTimeout() {
-        this.pollTimeout = setTimeout(this.callPoll, this.pollingIntervalMs);
-    }
-
-    private async callPoll() {
-        this.pollTimeout = null;
-        return Promise.resolve(this.poll(this.notificationCallback))
-            .catch(error => {
-                this.logger.error('error in pollCallback', { error: error.message });
-            })
-            .finally(() => {
-                if (!this.isSleeping) {
-                    this.setPollTimeout();
-                }
-            });
-    }
-
-    protected abstract poll(notificationCallback: T): any;
-}