@stackbit/dev 0.0.52 → 0.0.56-alpha.0

package/dist/services/logger.js

@@ -24,12 +24,15 @@ const createLogger = ({ label }) => {
             message: true
         }));
     }
-    return winston_1.default.createLogger({
+    const logger = winston_1.default.createLogger({
         level: config_1.default.logLevel,
         format: winston_1.default.format.combine(...formats),
         transports: transports
     });
+    logger.createLogger = exports.createLogger;
+    return logger;
 };
 exports.createLogger = createLogger;
+logger.createLogger = exports.createLogger;
 exports.default = logger;
 //# sourceMappingURL=logger.js.map

package/dist/services/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/services/logger.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,uDAA+B;AAE/B,MAAM,cAAc,GAAG,CAAC,iBAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,iBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AAE5E,MAAM,UAAU,GAAG;IACf,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,CAAC;QAC3B,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC;KACpD,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,GAAG,iBAAO,CAAC,YAAY,CAAC;IAChC,KAAK,EAAE,gBAAM,CAAC,QAAQ;IACtB,UAAU,EAAE,UAAU;CACzB,CAAC,CAAC;AAEI,MAAM,YAAY,GAAG,CAAC,EAAE,KAAK,EAAqB,EAAE,EAAE;IACzD,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC;IACvC,IAAI,KAAK,EAAE;QACP,OAAO,CAAC,IAAI,CACR,iBAAO,CAAC,MAAM,CAAC,KAAK,CAAC;YACjB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI;SAChB,CAAC,CACL,CAAC;KACL;IACD,OAAO,iBAAO,CAAC,YAAY,CAAC;QACxB,KAAK,EAAE,gBAAM,CAAC,QAAQ;QACtB,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;QAC1C,UAAU,EAAE,UAAU;KACzB,CAAC,CAAC;AACP,CAAC,CAAC;AAfW,QAAA,YAAY,gBAevB;AAEF,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/services/logger.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,uDAA+B;AAE/B,MAAM,cAAc,GAAG,CAAC,iBAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,iBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AAE5E,MAAM,UAAU,GAAG;IACf,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,CAAC;QAC3B,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC;KACpD,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,GAAG,iBAAO,CAAC,YAAY,CAAC;IAChC,KAAK,EAAE,gBAAM,CAAC,QAAQ;IACtB,UAAU,EAAE,UAAU;CACzB,CAAC,CAAC;AAEI,MAAM,YAAY,GAAG,CAAC,EAAE,KAAK,EAAqB,EAAkB,EAAE;IACzE,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC;IACvC,IAAI,KAAK,EAAE;QACP,OAAO,CAAC,IAAI,CACR,iBAAO,CAAC,MAAM,CAAC,KAAK,CAAC;YACjB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI;SAChB,CAAC,CACL,CAAC;KACL;IACD,MAAM,MAAM,GAAG,iBAAO,CAAC,YAAY,CAAC;QAChC,KAAK,EAAE,gBAAM,CAAC,QAAQ;QACtB,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;QAC1C,UAAU,EAAE,UAAU;KACzB,CAAC,CAAC;IACH,MAAM,CAAC,YAAY,GAAG,oBAAY,CAAC;IACnC,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAjBW,QAAA,YAAY,gBAiBvB;AAQF,MAAM,CAAC,YAAY,GAAG,oBAAY,CAAC;AAEnC,kBAAe,MAAM,CAAC"}

package/dist/types/api-methods.d.ts

@@ -0,0 +1,236 @@
+import { ContentStoreTypes } from '@stackbit/cms-core';
+import { CommitAuthor } from '@stackbit/dev-common';
+export declare type APIMethodName = APIMethod['method'];
+export declare type APIMethodForMethod<T, U> = U extends {
+    method: T;
+} ? U : never;
+export declare type APIMethodByMethod<T extends APIMethodName> = APIMethodForMethod<T, APIMethod>;
+export declare type APIMethodDataForMethod<T extends APIMethodName> = APIMethodByMethod<T>['data'];
+export declare type APIMethodResultForMethod<T extends APIMethodName> = APIMethodByMethod<T>['result'];
+export declare type APIMethod = APIMethodCreateDocument | APIMethodCreateAndLinkDocument | APIMethodUploadAndLinkAsset | APIMethodDuplicateDocument | APIMethodUpdateDocument | APIMethodValidateDocuments | APIMethodDeleteDocument | APIMethodGetAssets | APIMethodUploadAssets | APIMethodCreatePreset | APIMethodDeletePreset;
+export declare type APIMethodCreateDocument = {
+    method: 'createDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        modelName: string;
+        object?: Record<string, any>;
+        locale?: string;
+    };
+    result: {
+        srcDocumentId: string;
+    };
+};
+export declare type APIMethodCreateAndLinkDocument = {
+    method: 'createAndLinkDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+        fieldPath: (string | number)[];
+        modelName: string;
+        object?: Record<string, any>;
+        index?: number;
+        locale?: string;
+    };
+    result: {
+        srcDocumentId: string;
+    };
+};
+export declare type APIMethodUploadAndLinkAsset = {
+    method: 'uploadAndLinkAsset';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+        fieldPath: (string | number)[];
+        asset: UploadAssetData;
+        index?: number;
+        locale?: string;
+    };
+    result: {
+        srcDocumentId: string;
+    };
+};
+export declare type APIMethodDuplicateDocument = {
+    method: 'duplicateDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+        object?: Record<string, any>;
+    };
+    result: {
+        srcDocumentId: string;
+    };
+};
+export declare type APIMethodUpdateDocument = {
+    method: 'updateDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+        updateOperations: UpdateOperation[];
+    };
+    result: {
+        srcDocumentId: string;
+    };
+};
+export declare type APIMethodDeleteDocument = {
+    method: 'deleteDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+    };
+    result: void;
+};
+export declare type APIMethodValidateDocuments = {
+    method: 'validateDocuments';
+    data: {
+        objects: {
+            srcType: string;
+            srcProjectId: string;
+            srcObjectId: string;
+        }[];
+        locale?: string;
+    };
+    result: {
+        errors: ContentStoreTypes.ValidationError[];
+    };
+};
+export declare type APIMethodPublishDocuments = {
+    method: 'publishDocuments';
+    data: {
+        objects: {
+            srcType: string;
+            srcProjectId: string;
+            srcObjectId: string;
+        }[];
+    };
+    result: void;
+};
+export declare type APIMethodGetAssets = {
+    method: 'getAssets';
+    data: {
+        srcType?: string;
+        srcProjectId?: string;
+        pageSize?: number;
+        pageNum?: number;
+        searchQuery?: string;
+    };
+    result: {
+        assets: ContentStoreTypes.APIAsset[];
+        pageSize: number;
+        pageNum: number;
+        totalPages: number;
+    };
+};
+export declare type APIMethodUploadAssets = {
+    method: 'uploadAssets';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        assets: UploadAssetData[];
+        locale?: string;
+        user: any;
+    };
+    result: ContentStoreTypes.APIAsset[];
+};
+export declare type APIMethodCreatePreset = {
+    method: 'createPreset';
+    data: {
+        label: string;
+        metadata: any;
+        thumbnail: string;
+        fieldDataPath: string[];
+        user: CommitAuthor;
+        dryRun: boolean;
+    };
+    result: {
+        files: string[];
+        preset: {
+            modelName: string;
+            thumbnail?: string;
+            data: any;
+            label: string;
+            metadata: any;
+        };
+    };
+};
+export declare type APIMethodDeletePreset = {
+    method: 'deletePreset';
+    data: {
+        presetId: string;
+        user: CommitAuthor;
+    };
+    result: {
+        changes: {
+            filePath: string;
+            description: string;
+        }[];
+        filesRemoved: string[];
+    };
+};
+export interface UploadAssetData {
+    url: string;
+    data?: string;
+    metadata: {
+        name: string;
+        type: string;
+    };
+}
+export declare type UpdateOperation = UpdateOperationSet | UpdateOperationUnset | UpdateOperationInsert | UpdateOperationRemove | UpdateOperationReorder;
+export declare type UpdateOperationBase = {
+    opType: string;
+    fieldPath: (string | number)[];
+    locale?: string;
+};
+export declare type UpdateOperationSet = Simplify<UpdateOperationBase & {
+    opType: 'set';
+    field: UpdateOperationField;
+}>;
+export declare type UpdateOperationUnset = Simplify<UpdateOperationBase & {
+    opType: 'unset';
+}>;
+export declare type UpdateOperationInsert = Simplify<UpdateOperationBase & {
+    opType: 'insert';
+    index?: number;
+    item: UpdateOperationField;
+}>;
+export declare type UpdateOperationRemove = Simplify<UpdateOperationBase & {
+    opType: 'remove';
+    index: number;
+}>;
+export declare type UpdateOperationReorder = Simplify<UpdateOperationBase & {
+    opType: 'reorder';
+    order: number[];
+}>;
+export declare type UpdateOperationField = UpdateOperationValueField | UpdateOperationObjectField | UpdateOperationModelField | UpdateOperationReferenceField | UpdateOperationListField;
+export declare type UpdateOperationValueFieldType = Exclude<FieldType, 'object' | 'model' | 'reference' | 'list'>;
+export declare type UpdateOperationValueField = {
+    type: UpdateOperationValueFieldType;
+    value: any;
+};
+export declare type UpdateOperationObjectField = {
+    type: 'object';
+    object: Record<string, any>;
+};
+export declare type UpdateOperationModelField = {
+    type: 'model';
+    modelName: string;
+    object: Record<string, any>;
+};
+export declare type UpdateOperationReferenceField = {
+    type: 'reference';
+    refType: 'document' | 'asset';
+    refId: string;
+};
+export declare type UpdateOperationListField = {
+    type: 'list';
+    items: any[];
+};
+export declare type FieldType = 'string' | 'url' | 'slug' | 'text' | 'markdown' | 'html' | 'number' | 'boolean' | 'enum' | 'date' | 'datetime' | 'color' | 'image' | 'file' | 'json' | 'richText' | 'object' | 'model' | 'reference' | 'style' | 'list';
+export declare type Simplify<T> = {
+    [K in keyof T]: T[K];
+};

package/dist/types/api-methods.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-methods.js.map

package/dist/types/api-methods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-methods.js","sourceRoot":"","sources":["../../src/types/api-methods.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackbit/dev",
-  "version": "0.0.52",
+  "version": "0.0.56-alpha.0",
   "description": "stackbit-dev",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,9 +22,9 @@
   "author": "Stackbit Inc.",
   "license": "MIT",
   "dependencies": {
-    "@stackbit/cms-core": "^0.0.17",
-    "@stackbit/dev-common": "^0.0.48",
-    "@stackbit/sdk": "^0.2.35",
+    "@stackbit/cms-core": "0.0.21-alpha.0",
+    "@stackbit/dev-common": "0.0.52-alpha.0",
+    "@stackbit/sdk": "0.2.39-alpha.0",
     "axios": "^0.25.0",
     "chalk": "^4.1.0",
     "chokidar": "^3.5.3",
@@ -58,5 +58,5 @@
     "ts-jest": "^27.1.5",
     "typescript": "^4.5.4"
   },
-  "gitHead": "be61ec861035062e23384f341ba15e852ae26c3f"
+  "gitHead": "5d3055079122f4c4cc37fb1ec6916dc517a99194"
 }

package/src/dev.ts

@@ -17,6 +17,7 @@ interface DevOptions {
     runnableDir?: string;
     autoOpen?: boolean;
     cmsType?: string;
+    csiEnabled?: boolean;
     contentfulAccessToken?: string;
     contentfulSpaceIds?: [string];
     contentfulPreviewTokens?: [string];
@@ -48,7 +49,7 @@ export async function start(options: DevOptions) {
 
     if (options.contentfulSpaceIds) {
         localDetails.spaceIds = options.contentfulSpaceIds;
-    } 
+    }
     if (options.sanityProjectId) {
         localDetails.projectId = options.sanityProjectId;
     }
@@ -58,6 +59,10 @@ export async function start(options: DevOptions) {
             apiKey: options.cloudinaryApiKey
         };
     }
+    if (process.env.CSI_ENABLED) {
+        logger.debug('CSI Enabled');
+        options.csiEnabled = true;
+    }
 
     logger.debug('Local details', { localDetails });
     const studioUrl = `${config.appUrl}/local/${Buffer.from(JSON.stringify(localDetails)).toString('base64')}`;