@blinkk/root-cms 1.0.0-rc.9 → 1.0.1

package/dist/plugin.d.ts

@@ -1,8 +1,9 @@
 import { Request, Plugin } from '@blinkk/root';
 import { App } from 'firebase-admin/app';
-import { DecodedIdToken } from 'firebase-admin/auth';
 
-type CMSUser = DecodedIdToken;
+interface CMSUser {
+    email: string;
+}
 type CMSPluginOptions = {
     /**
      * The ID of the project. Data will be stored under the namespace
@@ -24,8 +25,16 @@ type CMSPluginOptions = {
         authDomain: string;
         projectId: string;
         storageBucket: string;
-        messagingSenderId: string;
-        appId: string;
+    };
+    /**
+     * GAPI credentials. Include if using Google Drive and Google Sheets features.
+     * See: https://developers.google.com/sheets/api/quickstart/js
+     */
+    gapi?: {
+        /** https://developers.google.com/sheets/api/quickstart/js#create_an_api_key */
+        apiKey: string;
+        /** https://developers.google.com/sheets/api/quickstart/js#authorize_credentials_for_a_web_application */
+        clientId: string;
     };
     /**
      * Secret value(s) used for signing the user authentication cookie.
@@ -35,6 +44,10 @@ type CMSPluginOptions = {
     cookieSecret?: string | string[];
     /** Function called to check if a user should have access to the CMS. */
     isUserAuthorized?: (req: Request, user: CMSUser) => boolean | Promise<boolean>;
+    /**
+     * Function to call to check if login is required for a particular request.
+     */
+    isLoginRequired?: (req: Request) => boolean;
     /**
      * URL to GCI service for transforming uploaded GCS images to a Google App
      * Engine Images API serving URL.
@@ -60,4 +73,4 @@ type CMSPlugin = Plugin & {
 };
 declare function cmsPlugin(options: CMSPluginOptions): CMSPlugin;
 
-export { CMSPlugin, CMSPluginOptions, CMSUser, cmsPlugin };
+export { type CMSPlugin, type CMSPluginOptions, type CMSUser, cmsPlugin };