@velora-cms/plugin-sdk 0.9.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,27 @@
+# @velora-cms/plugin-sdk
+
+The SDK for building Velora plugins: `definePlugin` for declaring a
+manifest, registries for data types and admin sections, storage-value
+providers for reading/writing plugin data, and a curated set of
+`@velora-cms/ui` components (`Panel`, `Input`, `Button`, and more) so
+plugin UIs match the host admin theme automatically.
+
+## Install
+
+```sh
+npm install @velora-cms/plugin-sdk
+```
+
+## Usage
+
+```ts
+import { definePlugin } from "@velora-cms/plugin-sdk";
+
+export default definePlugin({
+  id: "my-plugin",
+  type: "datatype",
+  // ...
+});
+```
+
+Part of [Velora](https://github.com/velora-cms/velora). Apache-2.0.

package/dist/admin-section-registry.d.ts

@@ -0,0 +1,4 @@
+import type { AdminSectionContribution } from "./manifest.js";
+export declare function registerAdminSection(section: AdminSectionContribution): void;
+export declare function getAdminSection(id: string): AdminSectionContribution | undefined;
+export declare function listAdminSections(): AdminSectionContribution[];

package/dist/admin-section-registry.js

@@ -0,0 +1,17 @@
+// Static registry, same shape as registry.ts's dataTypes map: built-ins
+// have none of these (only section plugins declare adminSections), so
+// every entry here comes from a dynamically-loaded remote (Month 8,
+// Session 91 — the first real consumer of this contribution).
+const adminSections = new Map();
+export function registerAdminSection(section) {
+    if (adminSections.has(section.id)) {
+        throw new Error(`An admin section with id "${section.id}" is already registered`);
+    }
+    adminSections.set(section.id, section);
+}
+export function getAdminSection(id) {
+    return adminSections.get(id);
+}
+export function listAdminSections() {
+    return [...adminSections.values()];
+}

package/dist/built-in-serializers.d.ts

@@ -0,0 +1,3 @@
+export type DataTypeSerializer = (value: unknown, settings: Record<string, unknown>) => unknown;
+export declare const identitySerializer: DataTypeSerializer;
+export declare const BUILT_IN_SERIALIZERS: Readonly<Record<string, DataTypeSerializer>>;

package/dist/built-in-serializers.js

@@ -0,0 +1,18 @@
+// The built-in datatypes' serialize/deserialize implementations, in a
+// deliberately React-free module: apps/server invokes these through the
+// ./datatypes subpath (Session 69's "no browser weight in the server
+// process" boundary), while built-ins.tsx re-imports them so the browser
+// registry contract is unchanged. All six are identity today (Session
+// 111 wires the PIPELINE, not new output shapes) — a built-in that needs
+// a real serialized projection later changes its entry here and nowhere
+// else. Keys are editor ids (DataTypeConfig.editorId), matching
+// BUILT_IN_DATA_TYPE_CONFIGS in @velora-cms/api-schemas.
+export const identitySerializer = (value) => value;
+export const BUILT_IN_SERIALIZERS = {
+    "com.velora.text": identitySerializer,
+    "com.velora.number": identitySerializer,
+    "com.velora.boolean": identitySerializer,
+    "com.velora.date": identitySerializer,
+    "com.velora.image": identitySerializer,
+    "com.velora.richtext": identitySerializer,
+};

package/dist/built-in-settings-schemas.d.ts

@@ -0,0 +1,6 @@
+import type { JSONSchema7 } from "json-schema";
+export declare const TEXT_SETTINGS_SCHEMA: JSONSchema7;
+export declare const TEXT_DEFAULT_SETTINGS: Record<string, unknown>;
+export declare const IMAGE_SETTINGS_SCHEMA: JSONSchema7;
+export declare const IMAGE_DEFAULT_SETTINGS: Record<string, unknown>;
+export declare const BUILT_IN_SETTINGS_SCHEMAS: Readonly<Record<string, JSONSchema7>>;

package/dist/built-in-settings-schemas.js

@@ -0,0 +1,37 @@
+// Settings schemas for built-in editors that have real, validated settings
+// (Session 69) — keyed by the SAME id built-ins.tsx registers under
+// (com.velora.<name>). Editors with no entry here have no server-side
+// settings validation: either they have no settings at all (empty
+// settingsSchema, e.g. number/boolean/date), or they're a third-party/
+// remote plugin the server has no way to load code for (Module Federation
+// remotes only ever run in the browser — see manifest-entry.ts). This is a
+// deliberate, documented scope boundary, not an oversight.
+//
+// Zero React import — this file (and the @velora-cms/plugin-sdk/datatypes
+// subpath that re-exports it) must stay importable from apps/server.
+export const TEXT_SETTINGS_SCHEMA = {
+    type: "object",
+    properties: {
+        placeholder: { type: "string" },
+        maxLength: { type: "integer", minimum: 1 },
+    },
+    additionalProperties: false,
+};
+// Deliberately {} — resolve-data-type.ts falls back to editor.defaultSettings
+// for any config with empty settings (all six seeded built-ins today), so a
+// non-empty default here would silently change every existing Text field's
+// behavior the moment this ships.
+export const TEXT_DEFAULT_SETTINGS = {};
+export const IMAGE_SETTINGS_SCHEMA = {
+    type: "object",
+    properties: {
+        acceptedTypes: { type: "array", items: { type: "string" } },
+        maxSizeBytes: { type: "integer", minimum: 1 },
+    },
+    additionalProperties: false,
+};
+export const IMAGE_DEFAULT_SETTINGS = {};
+export const BUILT_IN_SETTINGS_SCHEMAS = {
+    "com.velora.text": TEXT_SETTINGS_SCHEMA,
+    "com.velora.image": IMAGE_SETTINGS_SCHEMA,
+};

package/dist/built-ins.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/built-ins.js

@@ -0,0 +1,142 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Checkbox, Input, PropertyField } from "@velora-cms/ui";
+import { IMAGE_DEFAULT_SETTINGS, IMAGE_SETTINGS_SCHEMA, TEXT_DEFAULT_SETTINGS, TEXT_SETTINGS_SCHEMA, } from "./built-in-settings-schemas.js";
+import { BUILT_IN_SERIALIZERS, identitySerializer } from "./built-in-serializers.js";
+import { definePlugin } from "./define-plugin.js";
+import { usePluginSettings, usePluginSettingsValue, usePluginValue } from "./plugin-context.js";
+import { registerDataType } from "./registry.js";
+import { ImageInputView, ImageReadOnlyView, ImageSettingsView } from "./views/image-view.js";
+import { RichTextInputView, RichTextReadOnlyView } from "./views/rich-text-view.js";
+// Direct @velora-cms/ui dependency is TEMPORARY (Session 35) — built-ins are
+// statically compiled into the same admin bundle as @velora-cms/ui today, so
+// this is harmless. Must become the SDK's own curated re-export of
+// @velora-cms/ui before plugin-sdk is ever published standalone (Module
+// Federation, Month 4-5) — @velora-cms/ui is meant to stay private.
+function NotImplementedView() {
+    return null;
+}
+function TextInputView() {
+    const { value, onChange } = usePluginValue();
+    const settings = usePluginSettings();
+    return (_jsx(Input, { value: value ?? "", placeholder: settings.placeholder, 
+        // Hard limit: the browser physically blocks keystrokes past this —
+        // a different, config-level concept from FieldValidation.maxLength
+        // (field-row.tsx), which is a soft, validated-on-blur field rule.
+        maxLength: settings.maxLength, onChange: (e) => onChange(e.target.value) }));
+}
+function TextReadOnlyView() {
+    const { value } = usePluginValue();
+    return _jsx("p", { children: value ?? "" });
+}
+// Rendered by the Data Types editor only (data-type-editor.tsx) — a
+// settings-EDITING view, so it uses usePluginSettingsValue() (write path),
+// not usePluginSettings() (read-only, used by the input/readOnly views
+// above). Hardcoded English strings: this file has no access to
+// admin-ui's react-i18next instance — plugin-sdk views' i18n is a
+// separately-tracked, deliberately deferred SDK story (see SESSION_LOG.md),
+// matching ImageInputView's existing "Remove"/"Loading…" precedent.
+function TextSettingsView() {
+    const { value: settings, onChange } = usePluginSettingsValue();
+    return (_jsxs("div", { className: "flex flex-col gap-4", children: [_jsx(PropertyField, { label: "Placeholder text", htmlFor: "text-settings-placeholder", children: _jsx(Input, { id: "text-settings-placeholder", value: settings.placeholder ?? "", onChange: (e) => onChange({ ...settings, placeholder: e.target.value || undefined }) }) }), _jsx(PropertyField, { label: "Max length", htmlFor: "text-settings-max-length", helpText: "Blocks typing past this many characters. Leave blank for no limit.", children: _jsx(Input, { id: "text-settings-max-length", type: "number", min: 1, value: settings.maxLength ?? "", onChange: (e) => onChange({ ...settings, maxLength: e.target.value === "" ? undefined : Number(e.target.value) }) }) })] }));
+}
+function NumberInputView() {
+    const { value, onChange } = usePluginValue();
+    return (_jsx(Input, { type: "number", value: value ?? "", onChange: (e) => onChange(e.target.value === "" ? null : Number(e.target.value)) }));
+}
+function NumberReadOnlyView() {
+    const { value } = usePluginValue();
+    return _jsx("p", { children: value ?? "" });
+}
+function BooleanInputView() {
+    const { value, onChange } = usePluginValue();
+    return _jsx(Checkbox, { checked: !!value, onCheckedChange: (checked) => onChange(checked === true) });
+}
+function BooleanReadOnlyView() {
+    const { value } = usePluginValue();
+    return _jsx("p", { children: value ? "Yes" : "No" });
+}
+function DateInputView() {
+    const { value, onChange } = usePluginValue();
+    return _jsx(Input, { type: "date", value: value ?? "", onChange: (e) => onChange(e.target.value) });
+}
+function DateReadOnlyView() {
+    const { value } = usePluginValue();
+    return _jsx("p", { children: value ?? "" });
+}
+const NOT_IMPLEMENTED_VIEWS = {
+    input: NotImplementedView,
+    readOnly: NotImplementedView,
+    settings: NotImplementedView,
+};
+const NO_SETTINGS = { type: "object", properties: {} };
+function builtIn(id, name, icon, schema, views = NOT_IMPLEMENTED_VIEWS, options = {}) {
+    // Through definePlugin (Session 61) so built-ins take the exact
+    // validation path external plugins do — a regression in any built-in
+    // definition fails loudly at module load, not silently at render.
+    return definePlugin({
+        id: `com.velora.${id}`,
+        name,
+        icon,
+        version: "1.0.0",
+        type: "datatype",
+        schema,
+        settingsSchema: options.settingsSchema ?? NO_SETTINGS,
+        defaultSettings: options.defaultSettings ?? {},
+        views,
+        serialize: BUILT_IN_SERIALIZERS[`com.velora.${id}`] ?? identitySerializer,
+        deserialize: identitySerializer,
+    });
+}
+// Real views (Session 35) — settings stays NotImplementedView for four
+// of six (number/boolean/date/richtext) since they have no configurable
+// settings yet (empty settingsSchema). text and image gained real
+// settings + settingsSchema in Session 69, proving the settings pipeline
+// before Google Maps uses the exact same path.
+// `preview` is aliased to the same `readOnly` view (Session 41) — used by
+// the document type builder's per-field live preview while designing a
+// field, deliberately not a `disabled`-attribute wrapper around `input`:
+// the rich text view is TipTap/contenteditable, which a native `disabled`
+// cascade doesn't stop from being edited, but readOnly views render inert
+// markup regardless of datatype.
+registerDataType(builtIn("text", "Text", "type", { type: "string" }, {
+    input: TextInputView,
+    readOnly: TextReadOnlyView,
+    settings: TextSettingsView,
+    preview: TextReadOnlyView,
+}, { settingsSchema: TEXT_SETTINGS_SCHEMA, defaultSettings: TEXT_DEFAULT_SETTINGS }));
+registerDataType(builtIn("number", "Number", "hash", { type: "number" }, {
+    input: NumberInputView,
+    readOnly: NumberReadOnlyView,
+    settings: NotImplementedView,
+    preview: NumberReadOnlyView,
+}));
+registerDataType(builtIn("boolean", "Boolean", "toggle-left", { type: "boolean" }, {
+    input: BooleanInputView,
+    readOnly: BooleanReadOnlyView,
+    settings: NotImplementedView,
+    preview: BooleanReadOnlyView,
+}));
+registerDataType(builtIn("date", "Date", "calendar", { type: "string", format: "date" }, {
+    input: DateInputView,
+    readOnly: DateReadOnlyView,
+    settings: NotImplementedView,
+    preview: DateReadOnlyView,
+}));
+// Stores a media reference id — the Media Library item itself is
+// fetched separately (GET /api/media/:id), not embedded in the field
+// value. Full library browsing/picking from existing uploads is
+// Session 42; this view only uploads a new file.
+registerDataType(builtIn("image", "Image", "image", { type: "string" }, {
+    input: ImageInputView,
+    readOnly: ImageReadOnlyView,
+    settings: ImageSettingsView,
+    preview: ImageReadOnlyView,
+}, { settingsSchema: IMAGE_SETTINGS_SCHEMA, defaultSettings: IMAGE_DEFAULT_SETTINGS }));
+// TipTap's native JSON document shape, provisional until the full
+// content editor (Session 40/41) needs something more specific.
+registerDataType(builtIn("richtext", "Rich Text", "file-text", { type: "object" }, {
+    input: RichTextInputView,
+    readOnly: RichTextReadOnlyView,
+    settings: NotImplementedView,
+    preview: RichTextReadOnlyView,
+}));

package/dist/data-type-plugin.d.ts

@@ -0,0 +1,21 @@
+import type { ComponentType } from "react";
+import type { JSONSchema7 } from "json-schema";
+export interface DataTypePluginViews {
+    input: ComponentType;
+    readOnly: ComponentType;
+    settings: ComponentType;
+    preview?: ComponentType;
+}
+export interface DataTypePlugin {
+    id: string;
+    name: string;
+    icon: string;
+    version: string;
+    type: "datatype";
+    schema: JSONSchema7;
+    settingsSchema: JSONSchema7;
+    defaultSettings: Record<string, unknown>;
+    views: DataTypePluginViews;
+    serialize: (value: unknown, settings: Record<string, unknown>) => unknown;
+    deserialize: (raw: unknown, settings: Record<string, unknown>) => unknown;
+}

package/dist/data-type-plugin.js

@@ -0,0 +1 @@
+export {};

package/dist/datatypes-entry.d.ts

@@ -0,0 +1,2 @@
+export { BUILT_IN_SETTINGS_SCHEMAS } from "./built-in-settings-schemas.js";
+export { BUILT_IN_SERIALIZERS, identitySerializer, type DataTypeSerializer, } from "./built-in-serializers.js";

package/dist/datatypes-entry.js

@@ -0,0 +1,10 @@
+// The `@velora-cms/plugin-sdk/datatypes` subpath: server-safe settings-schema
+// DATA for built-in editors only — no React, no side-effect registration,
+// same "no browser weight in the server process" boundary as ./manifest
+// (Session 60). Exists so apps/server's Data Type routes can validate
+// config.settings against a built-in editor's settingsSchema without
+// importing built-ins.tsx (React/@velora-cms/ui). Third-party/remote plugin
+// settingsSchemas are NOT coverable here — Module Federation remotes only
+// ever load in the browser, so the server has no way to see one.
+export { BUILT_IN_SETTINGS_SCHEMAS } from "./built-in-settings-schemas.js";
+export { BUILT_IN_SERIALIZERS, identitySerializer, } from "./built-in-serializers.js";

package/dist/define-plugin.d.ts

@@ -0,0 +1,25 @@
+import type { DataTypePlugin } from "./data-type-plugin.js";
+/**
+ * Thrown when a plugin definition fails validation — catchable by the
+ * registry's install() (Session 62) and `velora-plugin validate`
+ * (Month 7), which want to report rather than crash.
+ */
+export declare class PluginDefinitionError extends Error {
+    constructor(message: string);
+}
+/**
+ * Validate a datatype plugin definition and hand it back. This is the
+ * one code path into the registry: built-ins construct their plugin
+ * objects through it (see built-ins.tsx), and external plugins do the
+ * same — so a missing required view fails LOUDLY at definition time,
+ * never silently at render time (plugin-sdk.md).
+ *
+ * Deliberately does NOT register: Module Federation remotes (Session 66)
+ * export the defined plugin object, and the HOST decides when it enters
+ * the registry (install/activate lifecycle) — a define-time side effect
+ * would take that control away. Pass the result to registerDataType.
+ *
+ * Returns the ORIGINAL object (not a parsed clone) — a plugin carries
+ * React components and closures whose identity should survive.
+ */
+export declare function definePlugin(plugin: DataTypePlugin): DataTypePlugin;

package/dist/define-plugin.js

@@ -0,0 +1,51 @@
+import { DataTypePluginSchema, formatIssues } from "./manifest-schema.js";
+/**
+ * Thrown when a plugin definition fails validation — catchable by the
+ * registry's install() (Session 62) and `velora-plugin validate`
+ * (Month 7), which want to report rather than crash.
+ */
+export class PluginDefinitionError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "PluginDefinitionError";
+    }
+}
+const REQUIRED_VIEWS = ["input", "readOnly", "settings"];
+/**
+ * Validate a datatype plugin definition and hand it back. This is the
+ * one code path into the registry: built-ins construct their plugin
+ * objects through it (see built-ins.tsx), and external plugins do the
+ * same — so a missing required view fails LOUDLY at definition time,
+ * never silently at render time (plugin-sdk.md).
+ *
+ * Deliberately does NOT register: Module Federation remotes (Session 66)
+ * export the defined plugin object, and the HOST decides when it enters
+ * the registry (install/activate lifecycle) — a define-time side effect
+ * would take that control away. Pass the result to registerDataType.
+ *
+ * Returns the ORIGINAL object (not a parsed clone) — a plugin carries
+ * React components and closures whose identity should survive.
+ */
+export function definePlugin(plugin) {
+    const id = typeof plugin === "object" && plugin !== null && typeof plugin.id === "string"
+        ? plugin.id
+        : "(unknown id)";
+    // Required views first, with purpose-built messages — Zod's generic
+    // "expected custom, received undefined" doesn't tell a plugin author
+    // what to fix.
+    const views = typeof plugin === "object" && plugin !== null ? plugin.views : undefined;
+    for (const viewName of REQUIRED_VIEWS) {
+        if (!views || views[viewName] == null) {
+            throw new PluginDefinitionError(`definePlugin: datatype plugin "${id}" is missing required view "${viewName}" ` +
+                `(input, readOnly and settings are required; preview is optional)`);
+        }
+    }
+    const result = DataTypePluginSchema.safeParse(plugin);
+    if (!result.success) {
+        throw new PluginDefinitionError(`definePlugin: datatype plugin "${id}" is invalid:\n` +
+            formatIssues(result.error.issues)
+                .map((line) => `  - ${line}`)
+                .join("\n"));
+    }
+    return plugin;
+}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+export type { DataTypePlugin, DataTypePluginViews } from "./data-type-plugin.js";
+export type { PluginType, DatabaseDialect, DatabaseCompatibility, PluginPermissions, PluginMigrationContext, PluginMigration, PluginMigrationValidation, PluginMigrationHooks, HookEvent, HookHandler, PluginHooks, ContentLifecycleHookPayload, PluginHookContext, AdminSectionContribution, DashboardWidgetContribution, ApiRouteContribution, ScheduledTaskContribution, MediaProcessorContribution, SettingsPageContribution, ContentTreeActionContribution, EditorToolbarContribution, ExposedServiceContribution, BundledTemplateContribution, SerializerContext, CustomFormatContribution, SerializerContribution, DataTypePluginContributions, SectionPluginContributions, TemplatePluginContributions, ThemePluginContributions, IntegrationPluginContributions, UtilityPluginContributions, BundlePluginContributions, PluginManifestBase, DataTypePluginManifest, SectionPluginManifest, TemplatePluginManifest, ThemePluginManifest, IntegrationPluginManifest, UtilityPluginManifest, BundlePluginManifest, CMSPlugin, } from "./manifest.js";
+export { CMSPluginSchema, DataTypePluginSchema, validatePluginManifest, type ValidatePluginManifestResult, } from "./manifest-schema.js";
+export { definePlugin, PluginDefinitionError } from "./define-plugin.js";
+export { registerDataType, getDataType, listDataTypes } from "./registry.js";
+export { registerAdminSection, getAdminSection, listAdminSections } from "./admin-section-registry.js";
+export { PluginValueProvider, PluginSettingsProvider, PluginApiProvider, usePluginValue, usePluginSettings, usePluginSettingsValue, usePluginApi, type PluginFetch, } from "./plugin-context.js";
+export { SimpleStorageValueProvider } from "./simple-storage-value-provider.js";
+export { Panel, type PanelProps } from "@velora-cms/ui";
+export { PropertyField, type PropertyFieldProps } from "@velora-cms/ui";
+export { Input, type InputProps } from "@velora-cms/ui";
+export { Button, type ButtonProps } from "@velora-cms/ui";
+export { Switch, type SwitchProps } from "@velora-cms/ui";
+export { Badge, type BadgeProps } from "@velora-cms/ui";
+export { cn } from "@velora-cms/ui";
+import "./built-ins.js";

package/dist/index.js

@@ -0,0 +1,27 @@
+export { CMSPluginSchema, DataTypePluginSchema, validatePluginManifest, } from "./manifest-schema.js";
+export { definePlugin, PluginDefinitionError } from "./define-plugin.js";
+export { registerDataType, getDataType, listDataTypes } from "./registry.js";
+export { registerAdminSection, getAdminSection, listAdminSections } from "./admin-section-registry.js";
+export { PluginValueProvider, PluginSettingsProvider, PluginApiProvider, usePluginValue, usePluginSettings, usePluginSettingsValue, usePluginApi, } from "./plugin-context.js";
+export { SimpleStorageValueProvider } from "./simple-storage-value-provider.js";
+// The SDK's curated re-export of @velora-cms/ui. @velora-cms/ui is published
+// (not private) because @velora-cms/plugin-sdk has a runtime dependency on
+// it — a registry install of the SDK would be unresolvable otherwise. This
+// is the first consumer to actually need it — built-ins.tsx
+// still imports @velora-cms/ui directly, a documented TEMPORARY shortcut valid
+// only because built-ins are compiled into the same admin bundle. Google
+// Maps (Session 74) is a separate package on the real public SDK surface, so
+// it goes through here instead, proving the boundary external plugin authors
+// will actually use. Grow this list as plugins need more of @velora-cms/ui, not
+// preemptively.
+export { Panel } from "@velora-cms/ui";
+export { PropertyField } from "@velora-cms/ui";
+export { Input } from "@velora-cms/ui";
+export { Button } from "@velora-cms/ui";
+export { Switch } from "@velora-cms/ui";
+export { Badge } from "@velora-cms/ui";
+export { cn } from "@velora-cms/ui";
+// Import for its registration side effect — loading this package's
+// entrypoint is what populates the registry with the six built-ins, no
+// separate manual init step for consumers.
+import "./built-ins.js";

package/dist/manifest-entry.d.ts

@@ -0,0 +1,6 @@
+export type { DataTypePlugin, DataTypePluginViews } from "./data-type-plugin.js";
+export type { PluginType, DatabaseDialect, DatabaseCompatibility, PluginPermissions, PluginMigrationContext, PluginMigration, PluginMigrationValidation, PluginMigrationHooks, HookEvent, HookHandler, PluginHooks, ContentLifecycleHookPayload, PluginHookContext, AdminSectionContribution, DashboardWidgetContribution, ApiRouteContribution, ScheduledTaskContribution, MediaProcessorContribution, SettingsPageContribution, ContentTreeActionContribution, EditorToolbarContribution, ExposedServiceContribution, BundledTemplateContribution, SerializerContext, CustomFormatContribution, SerializerContribution, DataTypePluginContributions, SectionPluginContributions, TemplatePluginContributions, ThemePluginContributions, IntegrationPluginContributions, UtilityPluginContributions, BundlePluginContributions, PluginManifestBase, DataTypePluginManifest, SectionPluginManifest, TemplatePluginManifest, ThemePluginManifest, IntegrationPluginManifest, UtilityPluginManifest, BundlePluginManifest, CMSPlugin, } from "./manifest.js";
+export { CLIENT_BUNDLE_TYPES, hasClientBundle } from "./manifest.js";
+export { CMSPluginSchema, DataTypePluginSchema, formatIssues, validatePluginManifest, type ValidatePluginManifestResult, } from "./manifest-schema.js";
+export type { PluginColumnType, PluginColumnSchema, PluginIndexSchema, PluginTableSchema, StructuredQueryBuilder, StructuredStorageTransaction, ScopedStructuredStorage, PublishedContent, PluginApiRouteContext, } from "./structured-storage-types.js";
+export { definePlugin, PluginDefinitionError } from "./define-plugin.js";