@nascentdigital/funnel-editor 4.4.18

package/README.md

@@ -0,0 +1,44 @@
+# Editor Domain 
+
+```mermaid
+classDiagram
+
+Site --* SiteRepository
+Site --> StaticPageTemplate
+StaticPageTemplate --> Page
+
+Page --> Block
+Page --* PageRepository
+StaticPageTemplate --* PageRepository
+Page --> Section
+Section --> Block
+
+namespace Explore {
+  class Site {
+    getTemplates(region)
+  }
+  class SiteRepository {
+    getTemplates(region)
+  }
+  class StaticPageTemplate {
+    getPage(language)
+  }
+}
+
+namespace Edit {
+  class Page {
+    body
+  }
+  class PageRepository {
+    getPage(language)
+    save(page)
+    publish(page)
+  }
+  class Block {
+  
+  }
+  class Section {
+  
+  }
+}
+```

package/dist/EditorApp.d.ts

@@ -0,0 +1,9 @@
+import 'filepond/dist/filepond.min.css';
+import 'filepond-plugin-image-preview/dist/filepond-plugin-image-preview.min.css';
+import 'filepond-plugin-media-preview/dist/filepond-plugin-media-preview.min.css';
+export declare function EditorApp({ fonts }: EditorRoot.Props): import("react/jsx-runtime").JSX.Element | null;
+export declare namespace EditorRoot {
+    type Props = {
+        fonts: string[];
+    };
+}

package/dist/EditorApp.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditorApp = EditorApp;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const client_1 = require("@nascentdigital/funnel-ui/client");
+const classnames_1 = __importDefault(require("classnames"));
+const react_1 = require("react");
+const react_hotkeys_hook_1 = require("react-hotkeys-hook");
+const core_1 = require("./core");
+const EditorRoutes_1 = require("./EditorRoutes");
+// styles
+require("filepond/dist/filepond.min.css");
+require("filepond-plugin-image-preview/dist/filepond-plugin-image-preview.min.css");
+require("filepond-plugin-media-preview/dist/filepond-plugin-media-preview.min.css");
+// component
+function EditorApp({ fonts }) {
+    // bind font to root on mount
+    (0, react_1.useEffect)(() => {
+        // skip if there are no fonts or HTML root
+        const html = funnel_core_1.Browser.getHtml();
+        if (fonts.length === 0 || !html) {
+            return;
+        }
+        // apply fonts (create a copy to unbind
+        const fontClasses = fonts.slice();
+        html.classList.add(...fontClasses);
+        // remove fonts on update
+        return () => html.classList.remove(...fontClasses);
+    }, [fonts]);
+    // skip ssr
+    if (typeof window === 'undefined') {
+        return null;
+    }
+    // render
+    return ((0, jsx_runtime_1.jsx)("div", { className: (0, classnames_1.default)('Editor-wrap', ...fonts), children: (0, jsx_runtime_1.jsx)(core_1.AppStateContainer, { children: (0, jsx_runtime_1.jsx)(core_1.SettingsContainer, { children: (0, jsx_runtime_1.jsx)(react_hotkeys_hook_1.HotkeysProvider, { children: (0, jsx_runtime_1.jsx)(core_1.EditorApiContainer, { children: (0, jsx_runtime_1.jsx)(core_1.AuthContainer, { children: (0, jsx_runtime_1.jsx)(client_1.BreakpointContainer, { children: (0, jsx_runtime_1.jsx)(client_1.BackdropContainer, { children: (0, jsx_runtime_1.jsx)(core_1.DialogContainer, { children: (0, jsx_runtime_1.jsx)(core_1.CenterSheetContainer, { children: (0, jsx_runtime_1.jsx)(core_1.SplashContainer, { children: (0, jsx_runtime_1.jsx)(core_1.SiteConfigContainer, { children: (0, jsx_runtime_1.jsx)(EditorRoutes_1.EditorRoutes, {}) }) }) }) }) }) }) }) }) }) }) }) }));
+}

package/dist/EditorRoutes.d.ts

@@ -0,0 +1 @@
+export declare function EditorRoutes(): import("react/jsx-runtime").JSX.Element | null;

package/dist/EditorRoutes.js

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditorRoutes = EditorRoutes;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const head_1 = __importDefault(require("next/head"));
+const react_1 = require("react");
+const changesets_1 = require("./changesets");
+const collection_1 = require("./collection");
+const core_1 = require("./core");
+const dashboard_1 = require("./dashboard");
+const devtools_1 = require("./devtools");
+const explore_1 = require("./explore");
+const onboarding_1 = require("./onboarding");
+const page_1 = require("./page");
+const users_1 = require("./users");
+// routes
+function EditorRoutes() {
+    // bind hooks
+    const { editorApi, authenticated } = (0, core_1.useAuthenticator)();
+    const router = (0, core_1.useEditorRouter)();
+    const { ready, route, region: { id: region } = {} } = router;
+    const siteConfig = (0, core_1.useSiteConfig)();
+    const appState = (0, core_1.useAppState)();
+    const siteContext = (0, react_1.useMemo)(() => ({
+        site: authenticated && region
+            ? new core_1.Site({ appState, editorApi, region })
+            : undefined
+    }), [appState, editorApi, authenticated, region]);
+    const collectionsContext = (0, react_1.useMemo)(() => ({
+        collections: authenticated
+            ? new core_1.Collections({ appState, editorApi })
+            : undefined
+    }), [appState, editorApi, authenticated]);
+    // show loader while warming up
+    if (!ready) {
+        return null;
+    }
+    // splash not-found if there's no route
+    if (!route) {
+        return (0, jsx_runtime_1.jsx)(core_1.NotFound, {});
+    }
+    // allow anonymous authentication
+    if (route.target === 'auth') {
+        return (0, jsx_runtime_1.jsx)(core_1.Auth, {});
+    }
+    // or render login if available
+    else if (route.target === 'login') {
+        return (0, jsx_runtime_1.jsx)(onboarding_1.Login, {});
+    }
+    // or render login reset
+    else if (route.target === 'login-reset') {
+        return (0, jsx_runtime_1.jsx)(onboarding_1.LoginReset, {});
+    }
+    // and force login for any other unauthenticated requests
+    else if (!authenticated) {
+        router.navigateToLogin({ mode: 'replace' }).catch(console.error);
+        return null;
+    }
+    // or show loader if site config is coming in
+    else if (!siteConfig.initialized) {
+        return null;
+    }
+    // or show blocked if blocked
+    else if (appState.blocked) {
+        return (0, jsx_runtime_1.jsx)(core_1.EditorBlocked, {});
+    }
+    // or show blocked if blocked
+    else if (appState.offline) {
+        return (0, jsx_runtime_1.jsx)(core_1.EditorOffline, {});
+    }
+    // handle authenticated routes
+    let page;
+    switch (route.target) {
+        case 'dashboard':
+            page = (0, jsx_runtime_1.jsx)(dashboard_1.Dashboard, {});
+            break;
+        case 'templates':
+            page = (0, jsx_runtime_1.jsx)(explore_1.SiteExplorer, { region: route.region });
+            break;
+        case 'pages':
+            page = (0, jsx_runtime_1.jsx)(explore_1.PageExplorer, { region: route.region, page: route.page });
+            break;
+        case 'page':
+            page = ((0, jsx_runtime_1.jsx)(page_1.PageEditor, { templateId: route.page, region: route.region, language: route.language, slug: route.slug }));
+            break;
+        case 'collections':
+            page = (0, jsx_runtime_1.jsx)(explore_1.CollectionsExplorer, {});
+            break;
+        case 'collection.items':
+            page = (0, jsx_runtime_1.jsx)(explore_1.CollectionExplorer, { type: route.type });
+            break;
+        case 'collection':
+            page = ((0, jsx_runtime_1.jsx)(collection_1.CollectionEditor, { type: route.type, language: route.language, groupId: route.groupId }));
+            break;
+        case 'changesets':
+            page = (0, jsx_runtime_1.jsx)(changesets_1.ChangeSetsExplorer, {});
+            break;
+        case 'changeset':
+            page = (0, jsx_runtime_1.jsx)(changesets_1.ChangeSetViewer, { changeSetId: route.changeSetId });
+            break;
+        case 'users':
+            page = (0, jsx_runtime_1.jsx)(users_1.UserExplorer, {});
+            break;
+        case 'devtools':
+            page = ((0, jsx_runtime_1.jsx)(devtools_1.Devtools, {}));
+            break;
+        default:
+            return (0, jsx_runtime_1.jsx)(core_1.NotFound, {});
+    }
+    // render page
+    return ((0, jsx_runtime_1.jsx)(core_1.SiteContext.Provider, { value: siteContext, children: (0, jsx_runtime_1.jsxs)(core_1.CollectionsContext.Provider, { value: collectionsContext, children: [(0, jsx_runtime_1.jsx)(head_1.default, { children: (0, jsx_runtime_1.jsxs)("title", { children: [funnel_core_1.AppConfig.brandConfig().name, " CMS"] }) }), page] }) }));
+}

package/dist/api/EditorApi.d.ts

@@ -0,0 +1,4 @@
+import type { NextRequest, NextResponse as NextResponseType } from 'next/server';
+export declare namespace EditorApi {
+    function process(request: NextRequest, NextResponse: typeof NextResponseType): Promise<NextResponseType<unknown>>;
+}

package/dist/api/EditorApi.js

@@ -0,0 +1,292 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditorApi = void 0;
+const cache_1 = require("next/cache");
+const funnel_cms_1 = require("@nascentdigital/funnel-cms");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const funnel_engine_1 = require("@nascentdigital/funnel-engine");
+const config_1 = require("@nascentdigital/funnel-engine/config");
+const auth_1 = require("./auth");
+const changeset_1 = require("./changeset");
+const collections_1 = require("./collections");
+const EditorApiCommand_1 = require("./EditorApiCommand");
+const files_1 = require("./files");
+const pages_1 = require("./pages");
+const site_config_1 = require("./site-config");
+const upgrade_1 = require("./upgrade");
+const users_1 = require("./users");
+// namespace
+var EditorApi;
+(function (EditorApi) {
+    // methods
+    async function process(request, NextResponse) {
+        // handle request
+        try {
+            // process auth callback
+            const url = new URL(request.url);
+            const params = url.searchParams;
+            if (params.has('auth')) {
+                return await processAuth(params.get('auth'), request, NextResponse);
+            }
+            // or process command
+            else {
+                return await processCommand(request, NextResponse);
+            }
+        }
+        // or return error on failure
+        catch (e) {
+            console.error('[EditorApi] caught error processing request', e);
+            // handle API error
+            if (e instanceof funnel_core_1.ApiError) {
+                return NextResponse.json({ error: e.serialize() }, { status: e.status });
+            }
+            // or handle other isometric errors
+            else {
+                return NextResponse.json({
+                    error: e instanceof funnel_core_1.IsometricError
+                        ? e.serialize()
+                        : new funnel_core_1.ServerError().serialize()
+                }, { status: 500 });
+            }
+        }
+    }
+    EditorApi.process = process;
+})(EditorApi || (exports.EditorApi = EditorApi = {}));
+// helpers
+async function processAuth(provider, request, NextResponse) {
+    console.debug(`[EditorApi] processing auth callback for "${provider}"`);
+    // get content client instance
+    const contentClient = funnel_cms_1.ContentClient.forEditor();
+    // create the appropriate auth command
+    const { jwtSecret, shaKey } = config_1.ServerConfig.editorConfig();
+    let authCommand;
+    switch (provider) {
+        case 'cms':
+            authCommand = new auth_1.CmsAuthCommand({ contentClient, jwtSecret, shaKey });
+            break;
+        case 'google':
+            authCommand = new auth_1.GoogleAuthCommand({ contentClient, jwtSecret, shaKey });
+            break;
+        default:
+            throw new funnel_core_1.NotImplementedError(`No support for "${provider}" authentication.`);
+    }
+    console.debug(`[EditorApi] authenticating "${authCommand.provider}" callback"`);
+    // authenticate (generates jwt)
+    const jwt = await authCommand.authenticate(request);
+    // determine callback url
+    const authCallbackUrl = new URL('/editor/auth', request.url);
+    authCallbackUrl.searchParams.set('jwt', jwt);
+    // return jwt if it's an api flow
+    if (authCommand.workflow === 'api') {
+        return NextResponse.json({ data: jwt });
+    }
+    // redirect to it
+    else {
+        return NextResponse.redirect(authCallbackUrl, { status: 302 });
+    }
+}
+async function processCommand(request, NextResponse) {
+    const startTime = Date.now();
+    console.debug('[EditorApi] processing command');
+    // parse payload + site config
+    const json = await request.json();
+    console.debug('[EditorApi] parsed request', (Date.now() - startTime) / 1000);
+    // guard type
+    const type = json.type;
+    if (!EditorApiCommand_1.EditorApiCommand.Type.filter(type)) {
+        throw new funnel_core_1.ArgumentError(`Unrecognized EditorApi type "${type !== null && type !== void 0 ? type : 'undefined'}"`);
+    }
+    // authenticate (might be anonymous)
+    const [{ user, contentClient, securedContentClient }, siteConfig] = await Promise.all([
+        createCommandContext(type, request),
+        getSiteConfig()
+    ]);
+    console.debug(`[EditorApi/${type}] verified user + config`, (Date.now() - startTime) / 1000);
+    // extract command
+    const commandArgs = Object.assign(Object.assign({}, json), { contentClient,
+        securedContentClient,
+        siteConfig });
+    let command;
+    switch (type) {
+        // assets
+        case 'getAsset':
+            command = new files_1.GetFileCommand(commandArgs);
+            break;
+        case 'getAssets':
+            command = new files_1.GetFilesCommand(commandArgs);
+            break;
+        case 'createAsset':
+            command = new files_1.CreateFileCommand(commandArgs);
+            break;
+        case 'updateAsset':
+            command = new files_1.UpdateFileCommand(commandArgs);
+            break;
+        case 'deleteAsset':
+            command = new files_1.DeleteFileCommand(commandArgs);
+            break;
+        // users
+        case 'getUsers':
+            command = new users_1.GetUsersCommand(commandArgs);
+            break;
+        case 'getUser':
+            command = new users_1.GetUserCommand(commandArgs);
+            break;
+        case 'getCurrentUser':
+            command = new users_1.GetCurrentUserCommand(commandArgs);
+            break;
+        case 'createUser':
+            command = new users_1.CreateUserCommand(commandArgs);
+            break;
+        case 'updateUser':
+            command = new users_1.UpdateUserCommand(commandArgs);
+            break;
+        case 'resetUser':
+            command = new users_1.ResetUserCommand(commandArgs);
+            break;
+        case 'deleteUser':
+            command = new users_1.DeleteUserCommand(commandArgs);
+            break;
+        // pages
+        case 'getPagesOverview':
+            command = new pages_1.GetPagesOverviewCommand(commandArgs);
+            break;
+        case 'searchPages':
+            command = new pages_1.SearchPagesCommand(commandArgs);
+            break;
+        case 'findPages':
+            command = new pages_1.FindPagesCommand(commandArgs);
+            break;
+        case 'getPageCounts':
+            command = new pages_1.GetPageCountsCommand(commandArgs);
+            break;
+        case 'getPageSummaries':
+            command = new pages_1.GetPageSummariesCommand(commandArgs);
+            break;
+        case 'getPageGroup':
+            command = new pages_1.GetPageGroup(commandArgs);
+            break;
+        case 'getPage':
+            command = new pages_1.GetPageCommand(commandArgs);
+            break;
+        case 'createPage':
+            command = new pages_1.CreatePageCommand(commandArgs);
+            break;
+        case 'duplicatePage':
+            command = new pages_1.DuplicatePageCommand(commandArgs);
+            break;
+        case 'updatePage':
+            command = new pages_1.UpdatePageCommand(commandArgs);
+            break;
+        case 'touchPage':
+            command = new pages_1.TouchPageCommand(commandArgs);
+            break;
+        case 'unpublishPage':
+            command = new pages_1.UnpublishPageCommand(commandArgs);
+            break;
+        case 'getPageDependants':
+            command = new pages_1.GetPageDependantsCommand(commandArgs);
+            break;
+        case 'getPageDependencies':
+            command = new pages_1.GetPageDependenciesCommand(commandArgs);
+            break;
+        // collections
+        case 'getCollectionsOverview':
+            command = new collections_1.GetCollectionsOverviewCommand(commandArgs);
+            break;
+        case 'getCollectionItems':
+            command = new collections_1.GetCollectionItemsCommand(commandArgs);
+            break;
+        case 'getCollectionGroup':
+            command = new collections_1.GetCollectionGroupCommand(commandArgs);
+            break;
+        case 'getCollection':
+            command = new collections_1.GetCollectionCommand(commandArgs);
+            break;
+        case 'createCollection':
+            command = new collections_1.CreateCollectionCommand(commandArgs);
+            break;
+        case 'duplicateCollection':
+            command = new collections_1.DuplicateCollectionCommand(commandArgs);
+            break;
+        case 'updateCollection':
+            command = new collections_1.UpdateCollectionCommand(commandArgs);
+            break;
+        case 'unpublishCollection':
+            command = new collections_1.UnpublishCollectionCommand(commandArgs);
+            break;
+        case 'getCollectionDependants':
+            command = new collections_1.GetCollectionDependantsCommand(commandArgs);
+            break;
+        case 'getCollectionDependencies':
+            command = new collections_1.GetCollectionDependenciesCommand(commandArgs);
+            break;
+        // changeset
+        case 'listChangeSetGroups':
+            command = new changeset_1.ListChangeSetGroupsCommand(commandArgs);
+            break;
+        case 'listChangeSets':
+            command = new changeset_1.ListChangeSetsCommand(commandArgs);
+            break;
+        case 'getChangeSet':
+            command = new changeset_1.GetChangeSetCommand(commandArgs);
+            break;
+        case 'commitChangeSet':
+            command = new changeset_1.CommitChangeSetCommand(commandArgs);
+            break;
+        case 'revertChangeSet':
+            command = new changeset_1.RevertChangeSetCommand(commandArgs);
+            break;
+        // upgrade
+        case 'upgradeStatus':
+            command = new upgrade_1.GetUpgradeStatusCommand(commandArgs);
+            break;
+        case 'executeUpgrade':
+            command = new upgrade_1.ExecuteUpgradeCommand(commandArgs);
+            break;
+        // upgrade
+        case 'getSiteConfig':
+            command = new site_config_1.GetSiteConfigCommand(commandArgs);
+            break;
+        case 'updateSiteConfig':
+            command = new site_config_1.UpdateSiteConfigCommand(commandArgs);
+            break;
+        default:
+            throw new funnel_core_1.NotImplementedError(`Unsupported command "${type}"`);
+    }
+    // execute command and return result
+    const result = await command.execute(user);
+    console.debug(`[EditorApi/${type}] completed command`, (Date.now() - startTime) / 1000);
+    // return response (as json)
+    return NextResponse.json({ data: result });
+}
+async function createCommandContext(type, request) {
+    // handle anonymous client (use server instance)
+    if (EditorApiCommand_1.EditorApiCommand.Type.isAnonymous(type)) {
+        return {
+            user: funnel_cms_1.User.UNAUTHENTICATED,
+            contentClient: funnel_cms_1.ContentClient.forServer()
+        };
+    }
+    // or masquerade as the user
+    else {
+        const { user: userData, contentClient } = await funnel_engine_1.SiteAuth.getAuthorization(request);
+        return {
+            user: new funnel_cms_1.User(userData),
+            contentClient,
+            securedContentClient: EditorApiCommand_1.EditorApiCommand.Type.isSecured(type)
+                ? funnel_cms_1.ContentClient.forServer()
+                : undefined
+        };
+    }
+}
+async function getSiteConfig() {
+    // fetch site config (use nextjs caching)
+    const brand = funnel_core_1.AppConfig.brand();
+    const tag = site_config_1.UpdateSiteConfigCommand.getRevalidationTag();
+    const getCachedSiteConfig = (0, cache_1.unstable_cache)(async () => funnel_cms_1.ContentClient.forServer().siteConfig.get({ brand }), [tag], {
+        revalidate: funnel_core_1.Duration.toSeconds('1h'),
+        tags: [tag]
+    });
+    // return config
+    return getCachedSiteConfig();
+}

package/dist/api/EditorApiCommand.d.ts

@@ -0,0 +1,32 @@
+import { ContentClient, SiteConfig, User } from '@nascentdigital/funnel-cms';
+export declare abstract class EditorApiCommand<TResult = any> {
+    readonly contentClient: ContentClient;
+    private readonly _securedContentClient?;
+    readonly siteConfig: SiteConfig.Data;
+    abstract readonly type: EditorApiCommand.Type;
+    protected constructor(args: EditorApiCommand.ConstructorArgs);
+    get securedContentClient(): ContentClient;
+    get isAnonymous(): boolean;
+    get isLockdownExempt(): boolean;
+    get revalidation(): EditorApiCommand.Revalidation;
+    execute(user: User): Promise<TResult>;
+    abstract onExecute(user: User): Promise<TResult>;
+    protected verifyBrandAccess(user: User, brand: string): void;
+}
+export declare namespace EditorApiCommand {
+    type Revalidation = 'never' | 'always' | 'prod';
+    type Type = 'getAssets' | 'getAsset' | 'createAsset' | 'uploadFile' | 'updateAsset' | 'deleteAsset' | 'getUsers' | 'getUser' | 'getCurrentUser' | 'createUser' | 'updateUser' | 'resetUser' | 'deleteUser' | 'getPagesOverview' | 'searchPages' | 'findPages' | 'getPageSummaries' | 'getPageGroup' | 'getPage' | 'getPageCounts' | 'createPage' | 'updatePage' | 'duplicatePage' | 'touchPage' | 'unpublishPage' | 'getPageDependants' | 'getPageDependencies' | 'getCollectionsOverview' | 'getCollectionItems' | 'getCollectionGroup' | 'getCollection' | 'createCollection' | 'duplicateCollection' | 'updateCollection' | 'unpublishCollection' | 'getCollectionDependants' | 'getCollectionDependencies' | 'listChangeSetGroups' | 'listChangeSets' | 'getChangeSet' | 'updateChangeSet' | 'deleteChangeSet' | 'commitChangeSet' | 'revertChangeSet' | 'upgradeStatus' | 'executeUpgrade' | 'getSiteConfig' | 'updateSiteConfig';
+    namespace Type {
+        function filter(value: string): value is Type;
+        function isAnonymous(type: Type): boolean;
+        function isSecured(type: Type): boolean;
+    }
+    type ConstructorArgs = {
+        contentClient: ContentClient;
+        securedContentClient?: ContentClient;
+        siteConfig: SiteConfig.Data;
+    };
+    type ChildArgs<T> = ConstructorArgs & {
+        data: T;
+    };
+}