@nascentdigital/funnel-cms 4.4.4

package/dist/strapi/StrapiContentClient.js

@@ -0,0 +1,105 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StrapiContentClient = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const webhook_1 = require("@slack/webhook");
+const client_1 = require("@strapi/client");
+const qs_1 = __importDefault(require("qs"));
+const StrapiAssetClient_1 = require("./StrapiAssetClient");
+const StrapiAuthClient_1 = require("./StrapiAuthClient");
+const StrapiChangeSetClient_1 = require("./StrapiChangeSetClient");
+const StrapiCollectionClient_1 = require("./StrapiCollectionClient");
+const StrapiPageClient_1 = require("./StrapiPageClient");
+const StrapiSiteConfigClient_1 = require("./StrapiSiteConfigClient");
+const StrapiUpgradeClient_1 = require("./StrapiUpgradeClient");
+const StrapiUserClient_1 = require("./StrapiUserClient");
+// class
+class StrapiContentClient {
+    constructor({ baseUrl, token, slackUrl }) {
+        // initialize instance variables
+        const slack = slackUrl
+            ? new webhook_1.IncomingWebhook(slackUrl)
+            : undefined;
+        this._baseUrl = baseUrl;
+        this._token = token;
+        this._client = (0, client_1.strapi)({
+            baseURL: baseUrl,
+            auth: token
+        });
+        this.auth = new StrapiAuthClient_1.StrapiAuthClient(this);
+        this.changeSets = new StrapiChangeSetClient_1.StrapiChangeSetClient(this);
+        this.files = new StrapiAssetClient_1.StrapiAssetClient(this);
+        this.pages = new StrapiPageClient_1.StrapiPageClient(this);
+        this.collections = new StrapiCollectionClient_1.StrapiCollectionClient(this);
+        this.upgrade = new StrapiUpgradeClient_1.StrapiUpgradeClient(this);
+        this.users = new StrapiUserClient_1.StrapiUserClient(this, slack);
+        this.siteConfig = new StrapiSiteConfigClient_1.StrapiSiteConfigClient(this);
+    }
+    get client() {
+        return this._client;
+    }
+    get token() {
+        // throw if token isn't set
+        const { _token } = this;
+        if (!_token) {
+            throw new funnel_core_1.InvalidOperationError('Cannot access token before authentication');
+        }
+        // return token
+        return _token;
+    }
+    set token(token) {
+        // change client if token changes
+        if (this._token !== token) {
+            // capture new token
+            this._token = token;
+            // create new client
+            this._client = (0, client_1.strapi)({
+                baseURL: this._baseUrl,
+                auth: token
+            });
+        }
+    }
+    clearToken() {
+        // change client if token changes
+        if (this._token) {
+            // clear token
+            delete this._token;
+            // create new client
+            this._client = (0, client_1.strapi)({
+                baseURL: this._baseUrl
+            });
+        }
+    }
+    async customRequest({ command, method = 'GET', params = {}, data, onError }) {
+        // create full query
+        const { client, token } = this;
+        const url = new URL(`/api/funnel/${command}`, client.baseURL);
+        url.search = qs_1.default.stringify(params, { addQueryPrefix: true });
+        // send request
+        const response = await fetch(url.href, {
+            method,
+            headers: {
+                Authorization: `Bearer ${token}`,
+                'Content-Type': 'application/json'
+            },
+            body: data
+        });
+        // handle errors (never return)
+        if (!response.ok) {
+            // process error if expected
+            if (onError) {
+                onError(await response.json());
+            }
+            // or throw generic error
+            else {
+                throw new funnel_core_1.ServerError(`Failed to invoke "${command}" command:` + response.statusText);
+            }
+        }
+        // return response
+        return response.json();
+    }
+}
+exports.StrapiContentClient = StrapiContentClient;

package/dist/strapi/StrapiContentClientFactory.d.ts

@@ -0,0 +1,13 @@
+import { RequiredBy } from '@nascentdigital/funnel-core';
+import { ContentClient } from '../api';
+import { StrapiContentClient } from './StrapiContentClient';
+export declare class StrapiContentClientFactory implements ContentClient.Factory {
+    private readonly _baseUrl;
+    private readonly _serverClient;
+    constructor(args: StrapiContentClientFactory.ConstructorArgs);
+    forServer(): StrapiContentClient;
+    forEditor(): StrapiContentClient;
+}
+export declare namespace StrapiContentClientFactory {
+    type ConstructorArgs = RequiredBy<StrapiContentClient.ConstructorArgs, 'token'>;
+}

package/dist/strapi/StrapiContentClientFactory.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StrapiContentClientFactory = void 0;
+const StrapiContentClient_1 = require("./StrapiContentClient");
+// factory
+class StrapiContentClientFactory {
+    constructor(args) {
+        // initialize instance variables
+        this._baseUrl = args.baseUrl;
+        this._serverClient = new StrapiContentClient_1.StrapiContentClient(args);
+    }
+    forServer() {
+        return this._serverClient;
+    }
+    forEditor() {
+        return new StrapiContentClient_1.StrapiContentClient({ baseUrl: this._baseUrl });
+    }
+}
+exports.StrapiContentClientFactory = StrapiContentClientFactory;

package/dist/strapi/StrapiPageClient.d.ts

@@ -0,0 +1,23 @@
+import { PageClient } from '../api';
+import type { IStrapiContentClient } from './IStrapiContentClient';
+export declare class StrapiPageClient implements PageClient {
+    private readonly provider;
+    constructor(provider: IStrapiContentClient);
+    getOverview({ brand, region, version }: PageClient.GetOverview.Args): Promise<PageClient.GetOverview.Result>;
+    getSummaries(args: PageClient.GetSummaries.Args): Promise<PageClient.GetSummaries.Result>;
+    getPreviews({ pagination, ...args }: PageClient.GetPreviews.Args): Promise<PageClient.GetPreviews.Result>;
+    search({ pagination, ...args }: PageClient.Search.Args): Promise<PageClient.Search.Result>;
+    query({ pagination, ...args }: PageClient.Query.Args): Promise<PageClient.Query.Result>;
+    find({ pagination, ...args }: PageClient.Find.Args): Promise<PageClient.Find.Result>;
+    getGroup({ brand, groupId, type, slug, region, language, version }: PageClient.GetGroup.Args): Promise<PageClient.GetGroup.Result>;
+    get(args: PageClient.Get.Args): Promise<PageClient.Get.Result>;
+    create(args: PageClient.Create.Args): Promise<PageClient.Create.Result>;
+    duplicate({ source: pageId, targetPage, targetLanguage, targetSlug }: PageClient.Duplicate.Args): Promise<PageClient.Duplicate.Result>;
+    touch({ id: pageId, version: status }: PageClient.Touch.Args): Promise<PageClient.Touch.Result>;
+    update({ id: pageId, slug: pageSlug, publication: pagePublication, errors, updates }: PageClient.Update.Args): Promise<PageClient.Update.Result>;
+    replace({ page, version, skipSync }: PageClient.Replace.Args): Promise<PageClient.Replace.Result>;
+    unpublish(pageId: PageClient.Unpublish.Args): Promise<PageClient.Unpublish.Result>;
+    getDependants({ id: pageId, version }: PageClient.GetDependants.Args): Promise<PageClient.GetDependants.Result>;
+    getDependencies({ id: pageId, version }: PageClient.GetDependencies.Args): Promise<PageClient.GetDependencies.Result>;
+    validateSlug({ brand, type, region, slug, groupId }: PageClient.ValidateSlug.Args): Promise<PageClient.ValidateSlug.Result>;
+}