@sevenfold/setto-client 0.6.2 → 0.7.0

package/dist/modules/index.d.ts

@@ -0,0 +1,5 @@
+import type { SettoModule } from './module';
+export type { SettoModule } from './module';
+/** Every module the dashboard shows, in tab order. */
+export declare const SETTO_MODULES: readonly SettoModule[];
+export declare function findModule(id: string | null): SettoModule | undefined;

package/dist/modules/module.d.ts

@@ -0,0 +1,30 @@
+import type { ComponentType } from 'react';
+/**
+ * What a Setto module is, from the client's side.
+ *
+ * A module is a capability a site gets by using the library — forms today;
+ * bookings, newsletters, reviews later. Each one is a directory under
+ * `src/modules/<id>` that owns its three faces:
+ *
+ *   - a primitive the site renders (`SettoForm`), with edit chrome for the
+ *     owner and content that lives in the locale so it publishes with the
+ *     rest of the site;
+ *   - a panel in the dashboard at `/setto?view=<id>` (`AdminView`), reached
+ *     from the editor toolbar's settings item;
+ *   - an api segment (`createFormsApi`) that `createApi` mounts under its id,
+ *     against routes setto-server keeps under `src/modules/<id>`.
+ *
+ * Registering the module in `src/modules/index.ts` is what puts its tab in
+ * the dashboard. The primitive and the types are exported from the package
+ * root like everything else.
+ */
+export interface SettoModule {
+    /** Stable id — also the dashboard view name and the api segment name. */
+    id: string;
+    /** Tab label in the dashboard, in Norwegian. */
+    label: string;
+    /** The dashboard panel for the current site. */
+    AdminView: ComponentType<{
+        siteId: string;
+    }>;
+}