@blinkk/root-cms 1.0.1-alpha.0 → 1.0.1

package/dist/plugin.d.ts

@@ -0,0 +1,76 @@
+import { Request, Plugin } from '@blinkk/root';
+import { App } from 'firebase-admin/app';
+
+interface CMSUser {
+    email: string;
+}
+type CMSPluginOptions = {
+    /**
+     * The ID of the project. Data will be stored under the namespace
+     * `Projects/${id}` in firestore.
+     */
+    id?: string;
+    /**
+     * The name of the project. Used in the header of the CMS to help identify
+     * the project.
+     */
+    name?: string;
+    /**
+     * Firebase config object, which can be obtained in the Firebase Console by
+     * going to "Project Settings".
+     */
+    firebaseConfig: {
+        [key: string]: string;
+        apiKey: string;
+        authDomain: string;
+        projectId: string;
+        storageBucket: 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.
+     * @deprecated This is now handled directly by root's sessionMiddleware under
+     * `server.sessionCookieSecret` in root.config.ts.
+     */
+    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.
+     *
+     * Setting this to `true` uses the default hosted service at
+     * https://gci.rootjs.dev.
+     *
+     * To set up GCI:
+     *
+     * - Create a GCS bucket with fine-grained permissions
+     * - Share owner access to the bucket with the service account returned in
+     *   https://gci.rootjs.dev/_/service_account
+     *
+     * To disable GCI, leave this value empty or set to `false`, which which will
+     * serve images directly from GCS instead.
+     */
+    gci?: string | boolean;
+};
+type CMSPlugin = Plugin & {
+    name: 'root-cms';
+    getConfig: () => CMSPluginOptions;
+    getFirebaseApp: () => App;
+};
+declare function cmsPlugin(options: CMSPluginOptions): CMSPlugin;
+
+export { type CMSPlugin, type CMSPluginOptions, type CMSUser, cmsPlugin };