@stackbit/dev 1.0.10-staging.1 → 1.0.11-develop.2

package/src/runner/index.ts

@@ -13,7 +13,6 @@ import {
     SSGRunOptions,
     DEFAULT_SSG_OPTIONS
 } from '@stackbit/sdk';
-import { ContentStoreTypes } from '@stackbit/cms-core';
 import type { FSWatcher } from 'chokidar';
 
 import { watchDir } from '../services/file-watcher';
@@ -45,9 +44,16 @@ import {
     APIMethodGetCustomActions,
     APIMethodRunCustomAction,
     APIMethodGetDocumentVersions,
-    APIMethodGetDocumentForVersion
+    APIMethodGetDocumentForVersion,
+    APIMethodGetCollections,
+    APIMethodGetSiteMap,
+    APIMethodGetTreeViews,
+    APIMethodGetSchema,
+    APIMethodGetObjects,
+    APIMethodGetObjectsWithAnnotations,
+    APIMethodGetDocuments
 } from '../types/api-methods';
-import { DocumentSpecifier, Logger } from '@stackbit/types';
+import { Logger } from '@stackbit/types';
 import { checkAndLogContentSourceVersions } from '@stackbit/dev-common';
 
 interface RunnerOptions {
@@ -268,12 +274,12 @@ export default class Runner implements APIMethodInterface {
         return this.ssg.directChangeSocketOrigin;
     }
 
-    async getObjects({ objectIds, locale }: { objectIds?: string[]; locale?: string }): Promise<{ objects: ContentStoreTypes.APIObject[] }> {
-        return this.editor.getObjects({ objectIds, locale });
+    async getObjects({ objectIds, locale, user }: APIMethodGetObjects['data']): Promise<APIMethodGetObjects['result']> {
+        return this.editor.getObjects({ objectIds, locale, user });
     }
 
-    async getDocuments({ documentSpecs }: { documentSpecs?: DocumentSpecifier[] }) {
-        return this.contentStoreAdapter.getApiDocuments({ documentSpecs });
+    async getDocuments({ documentSpecs, user }: APIMethodGetDocuments['data']): Promise<APIMethodGetDocuments['result']> {
+        return this.contentStoreAdapter.getApiDocuments({ documentSpecs, user });
     }
 
     async getObjectsWithAnnotations({
@@ -281,19 +287,15 @@ export default class Runner implements APIMethodInterface {
         clientAnnotationErrors = [],
         resolveAllReferences,
         sourcemaps,
-        locale
-    }: {
-        annotationTree: any;
-        clientAnnotationErrors: any;
-        resolveAllReferences?: boolean;
-        sourcemaps?: any;
-        locale?: string;
-    }) {
+        locale,
+        user
+    }: APIMethodGetObjectsWithAnnotations['data']): Promise<APIMethodGetObjectsWithAnnotations['result']> {
         const result = await this.editor.getObjectsWithAnnotations({
             annotationTree,
             clientAnnotationErrors,
             resolveAllReferences,
             locale,
+            user,
             reportAllErrors: true
         });
         const errors = [...(result.errors ?? []), ...clientAnnotationErrors];
@@ -301,20 +303,20 @@ export default class Runner implements APIMethodInterface {
         return result;
     }
 
-    async getCollections({ locale }: { locale?: string }) {
-        return this.editor.getCollections({ locale });
+    async getCollections({ locale, user }: APIMethodGetCollections['data']): Promise<APIMethodGetCollections['result']> {
+        return this.editor.getCollections({ locale, user });
     }
 
-    async getSiteMap({ locale }: { locale?: string }) {
-        return this.editor.getSiteMap({ locale });
+    async getSiteMap({ locale, user }: APIMethodGetSiteMap['data']): Promise<APIMethodGetSiteMap['result']> {
+        return this.editor.getSiteMap({ locale, user });
     }
 
-    async getTreeViews() {
-        return this.contentStoreAdapter.getTreeViews();
+    async getTreeViews({ user }: APIMethodGetTreeViews['data']): Promise<APIMethodGetTreeViews['result']> {
+        return this.contentStoreAdapter.getTreeViews({ user });
     }
 
-    async getSchema({ locale }: { locale?: string }) {
-        return this.editor.getSchema({ locale });
+    async getSchema({ locale, user }: APIMethodGetSchema['data']): Promise<APIMethodGetSchema['result']> {
+        return this.editor.getSchema({ locale, user });
     }
 
     async getUrl(srcDocumentId: string, srcProjectId: string, srcType: string, locale?: string): Promise<string | null> {

package/src/server/routes.ts

@@ -4,7 +4,7 @@ import bodyParser from 'body-parser';
 import Runner from '../runner';
 import logger from '../services/logger';
 import { PageNotFoundError } from '@stackbit/dev-common/dist/services/response-errors';
-import { APIMethod, APIMethodDataForMethod, APIMethodName, APIMethodResultForMethod } from '../types/api-methods';
+import { APIMethod, APIMethodName } from '../types/api-methods';
 
 const authMiddleware = (uuid: string) => {
     return (req: Request, res: Response, next: NextFunction) => {

package/src/types/api-methods.ts

@@ -1,5 +1,5 @@
 import { ContentStoreTypes } from '@stackbit/cms-core';
-import { CollectionItemWithModel } from '@stackbit/dev-common';
+import { CollectionItemWithModel, SiteMap, Collections, Schema } from '@stackbit/dev-common';
 import { Preset } from '@stackbit/sdk';
 import { DocumentSpecifier, ScheduledActionWithSource, TreeViewNode } from '@stackbit/types';
 
@@ -25,7 +25,12 @@ export type APIMethod =
     | APIMethodDeletePreset
     | APIMethodSearchDocuments
     | APIMethodOnWebhook
-    | APIMethodTreeViews
+    | APIMethodGetTreeViews
+    | APIMethodGetSiteMap
+    | APIMethodGetCollections
+    | APIMethodGetSchema
+    | APIMethodGetObjects
+    | APIMethodGetObjectsWithAnnotations
     | APIMethodGetDocuments
     | APIMethodGetScheduledActions
     | APIMethodCreateScheduledAction
@@ -216,6 +221,7 @@ export type APIMethodGetAssets = {
         pageSize?: number;
         pageNum?: number;
         searchQuery?: string;
+        user?: ContentStoreTypes.User;
     };
     result: {
         assets: ContentStoreTypes.APIAsset[];
@@ -285,6 +291,7 @@ export type APIMethodSearchDocuments = {
         }>;
         locale?: string;
         filter: ContentStoreTypes.SearchFilter;
+        user?: ContentStoreTypes.User;
     };
     result: {
         items: CollectionItemWithModel[];
@@ -299,6 +306,7 @@ export type APIMethodGetDocumentVersions = {
         srcProjectId: string;
         documentId: string;
         locale?: string;
+        user?: ContentStoreTypes.User;
     };
     result: { versions: ContentStoreTypes.APIDocumentVersion[] };
 };
@@ -311,6 +319,7 @@ export type APIMethodGetDocumentForVersion = {
         documentId: string;
         versionId: string;
         locale?: string;
+        user?: ContentStoreTypes.User;
     };
     result: { version: ContentStoreTypes.APIDocumentVersionWithDocument };
 };
@@ -338,18 +347,75 @@ export type APIMethodRunCustomAction = {
     result: void;
 };
 
-export type APIMethodTreeViews = {
+export type APIMethodGetTreeViews = {
     method: 'getTreeViews';
-    data: void;
+    data: { user?: ContentStoreTypes.User };
     result: TreeViewNode[];
 };
 
+export type APIMethodGetSiteMap = {
+    method: 'getSiteMap';
+    data: {
+        locale?: string;
+        user?: ContentStoreTypes.User;
+    };
+    result: SiteMap;
+};
+
+export type APIMethodGetCollections = {
+    method: 'getCollections';
+    data: {
+        locale?: string;
+        user?: ContentStoreTypes.User;
+    };
+    result: Collections;
+};
+
+export type APIMethodGetSchema = {
+    method: 'getSchema';
+    data: {
+        locale?: string;
+        user?: ContentStoreTypes.User;
+    };
+    result: Schema;
+};
+
 export type APIMethodGetDocuments = {
     method: 'getDocuments';
-    data: { documentSpecs?: DocumentSpecifier[] };
+    data: {
+        documentSpecs?: DocumentSpecifier[];
+        user?: ContentStoreTypes.User;
+    };
     result: { documents: ContentStoreTypes.APIDocument[] };
 };
 
+export type APIMethodGetObjects = {
+    method: 'getObjects';
+    data: {
+        objectIds?: string[];
+        locale?: string;
+        user?: ContentStoreTypes.User;
+    };
+    result: { objects: ContentStoreTypes.APIObject[] };
+};
+
+export type APIMethodGetObjectsWithAnnotations = {
+    method: 'getObjectsWithAnnotations';
+    data: {
+        annotationTree: any;
+        clientAnnotationErrors: any;
+        resolveAllReferences?: boolean;
+        sourcemaps?: any;
+        locale?: string;
+        user?: ContentStoreTypes.User;
+    };
+    result: {
+        objects: ContentStoreTypes.APIObject[];
+        pathMap: any;
+        errors: any[];
+    };
+};
+
 export interface UploadAssetData {
     url: string;
     data?: string;

package/dist/runner/ssg.d.ts

@@ -1,8 +0,0 @@
-declare const _default: {
-    directPaths: string[];
-    directRoutes: {};
-    directChangeSocketOrigin: boolean;
-    directChangeOrigin: boolean;
-};
-export default _default;
-//# sourceMappingURL=ssg.d.ts.map

package/dist/runner/ssg.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ssg.d.ts","sourceRoot":"","sources":["../../src/runner/ssg.ts"],"names":[],"mappings":";;;;;;AAAA,wBAKE"}

package/dist/runner/ssg.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    directPaths: ['/_next/**', '/nextjs-live-updates/**'],
-    directRoutes: {},
-    directChangeSocketOrigin: false,
-    directChangeOrigin: true
-};
-//# sourceMappingURL=ssg.js.map

package/dist/runner/ssg.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ssg.js","sourceRoot":"","sources":["../../src/runner/ssg.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACX,WAAW,EAAE,CAAC,WAAW,EAAE,yBAAyB,CAAC;IACrD,YAAY,EAAE,EAAE;IAChB,wBAAwB,EAAE,KAAK;IAC/B,kBAAkB,EAAE,IAAI;CAC3B,CAAC"}