@easy-cms/core 0.47.4 → 0.49.0

package/dist/plugin-EX9OHwR3.d.ts

@@ -0,0 +1,326 @@
+import { ba as Label, aD as Field, I as ID, k as AdminLocale, t as AdminSwitcher, c1 as SsoProviderRef } from './config-jzFGsNL6.js';
+import { FieldCondition } from './conditions.js';
+
+/** A Web Component from an admin module, with its `props` (plain JSON). */
+interface AdminComponentRef {
+    tag: string;
+    props?: Record<string, unknown>;
+    /** A side panel at the top of the side column (`position: 'top'`). */
+    position?: 'top';
+}
+/** Where the edit page puts its fields (`admin.layout`), with unplaced fields filled in. */
+type AdminLayoutNode = {
+    type: 'field';
+    name: string;
+} | {
+    type: 'row';
+    fields: string[];
+} | {
+    type: 'collapsible';
+    label: Label;
+    collapsed?: boolean;
+    description?: Label;
+    nodes: AdminLayoutNode[];
+} | {
+    type: 'tab';
+    label: Label;
+    description?: Label;
+    nodes: AdminLayoutNode[];
+};
+/** An entry of the admin menu. */
+type AdminNavItem = {
+    kind: 'collection';
+    slug: string;
+} | {
+    kind: 'global';
+    slug: string;
+} | {
+    kind: 'page';
+    path: string;
+} | {
+    kind: 'view';
+    view: 'roles' | 'sso' | 'backups' | 'email' | 'deliveries' | 'audit';
+};
+/** A group of the admin menu (`admin.nav`), with what this user may open in it. */
+interface AdminNavGroup {
+    kind: 'group';
+    id: string;
+    label: Label;
+    icon?: string;
+    items: AdminNavNode[];
+}
+type AdminNavNode = AdminNavItem | AdminNavGroup;
+/** A field as the admin UI sees it: plain JSON, no functions. */
+interface AdminField {
+    name: string;
+    type: Field['type'];
+    label?: Label;
+    required?: boolean;
+    unique?: boolean;
+    defaultValue?: unknown;
+    minLength?: number;
+    maxLength?: number;
+    min?: number;
+    max?: number;
+    options?: {
+        label: Label;
+        value: string;
+    }[];
+    hasMany?: boolean;
+    to?: string;
+    /** An upload's allowed file types, e.g. `image/*`. */
+    mimeTypes?: string[];
+    /** An upload's media folder (`folder`): where its picker opens; `only`: nowhere else. */
+    folder?: {
+        id: ID;
+        only: boolean;
+    };
+    /** A relationship with `filterOptions`: the picker asks the server which documents fit. */
+    filtered?: boolean;
+    from?: string;
+    minRows?: number;
+    maxRows?: number;
+    fields?: AdminField[];
+    /** Block kinds of a `blocks` field. */
+    blocks?: {
+        slug: string;
+        labels?: {
+            singular?: Label;
+            plural?: Label;
+        };
+        fields: AdminField[];
+    }[];
+    /** The current user may not change this field. */
+    readOnly?: boolean;
+    /** One value per content locale. */
+    localized?: boolean;
+    /** Shown in the edit page's side panel. */
+    position?: 'sidebar';
+    /** Components from admin modules: instead of the input, below the field, and in lists. */
+    admin?: {
+        component?: AdminComponentRef;
+        after?: AdminComponentRef[];
+        cell?: AdminComponentRef;
+    };
+    /** A column of the list at first (`admin.column`). */
+    column?: boolean;
+    /** A relationship that offers no "Create" in place (`admin.allowCreate: false`). */
+    noCreate?: boolean;
+    /** A field of an added type (`fieldTypes`), e.g. `color`; `type` is the base it's stored as. */
+    customType?: string;
+    /** Help below its label (`admin.description`). */
+    description?: Label;
+    /** Its share of a row (`admin.width`). */
+    width?: string;
+    /** Shown only when its siblings match (`admin.condition`). */
+    condition?: FieldCondition;
+}
+interface AdminCollection {
+    slug: string;
+    labels?: {
+        singular?: Label;
+        plural?: Label;
+    };
+    icon?: string;
+    useAsTitle?: string;
+    /** Documents open in a panel over the list. */
+    editIn?: 'drawer';
+    drafts: boolean;
+    versions: boolean;
+    /** Has live preview (`preview` in the config). */
+    preview: boolean;
+    /** Publishing can be scheduled. */
+    schedule: boolean;
+    fields: AdminField[];
+    /** Panels from admin modules in the edit page's side column. */
+    sidebar?: AdminComponentRef[];
+    /** Tabs, sections and rows of the edit page (`admin.layout`). */
+    layout?: AdminLayoutNode[];
+    /** A number in the menu (`admin.badge`); the menu's counts come from `GET <api>/admin/ui/counts`. */
+    badge?: {
+        tone: 'accent' | 'warning' | 'danger';
+        label?: Label;
+    };
+    /** No document count beside it in the menu (`admin.count: false`). */
+    noCount?: boolean;
+    /** What the list says while it has no documents (`admin.empty`). */
+    empty?: {
+        description?: Label;
+        link?: {
+            label: Label;
+            href: string;
+        };
+    };
+    /** The list is a tree along this relationship field (`admin.list.tree`). */
+    tree?: string;
+    /** The list's default order (`admin.list.sort`). */
+    defaultSort?: string;
+    permissions: {
+        read: boolean;
+        create: boolean;
+        update: boolean;
+        delete: boolean;
+        publish: boolean;
+    };
+    /** With `auth.rbac`: the field naming a document's owner (`createdBy` or `admin.ownerField`). */
+    owner?: string;
+    /** Deleting asks to type the title, and says what goes too (`admin.confirmDelete`). */
+    confirmDelete?: {
+        typeTitle?: boolean;
+        impact?: string;
+    };
+}
+interface AdminGlobal {
+    slug: string;
+    label?: Label;
+    icon?: string;
+    drafts: boolean;
+    versions: boolean;
+    /** Has live preview (`preview` in the config). */
+    preview: boolean;
+    /** Publishing can be scheduled. */
+    schedule: boolean;
+    fields: AdminField[];
+    /** Panels from admin modules in the edit page's side column. */
+    sidebar?: AdminComponentRef[];
+    /** Tabs, sections and rows of the edit page (`admin.layout`). */
+    layout?: AdminLayoutNode[];
+    permissions: {
+        read: boolean;
+        update: boolean;
+        publish: boolean;
+    };
+}
+/** A page of its own in the admin (`admin.pages`) that this user may open. */
+interface AdminPageRef {
+    path: string;
+    label: Label;
+    icon?: string;
+    component: AdminComponentRef;
+}
+/** A dashboard panel (`admin.dashboard`) this user may see. */
+interface AdminWidgetRef {
+    component: AdminComponentRef;
+    width: 'half' | 'full';
+}
+interface AdminSchema {
+    locale: AdminLocale;
+    /** A choice for the whole admin, e.g. the tenant (`admin.switcher`). */
+    switcher: AdminSwitcher | null;
+    /** Admins can email users links to set their password (needs `email` and `serverURL`). */
+    passwordLinks: boolean;
+    /** The menu: groups and what this user may open in them, in order. */
+    nav: AdminNavNode[];
+    /** More entries of the command palette (`admin.commands`). */
+    commands: {
+        label: Label;
+        href: string;
+        icon?: string;
+        keywords?: string[];
+    }[];
+    /** Content locales, when the config has `localization`. */
+    localization: {
+        locales: string[];
+        defaultLocale: string;
+    } | null;
+    collections: AdminCollection[];
+    globals: AdminGlobal[];
+    /** URLs under the API of the admin modules to load (`admin.modules`). */
+    modules: string[];
+    /** Files can be uploaded from links (`upload.fromURL`). */
+    uploadFromURL: boolean;
+    /** What the media library takes (`upload.maxFileSize`, `upload.mimeTypes` with groups expanded). */
+    upload: {
+        maxFileSize: number;
+        mimeTypes: string[];
+    };
+    /**
+     * The media library has folders (`upload.folders`); `permissions`: this user may choose which
+     * roles use each folder (admins, with `auth.rbac`).
+     */
+    folders?: {
+        permissions: boolean;
+        private: boolean;
+    };
+    /** Which saved deliveries the admin can show (webhooks, emails), for users who may see them. */
+    deliveries?: {
+        webhook: boolean;
+        email: boolean;
+    };
+    /** Admin pages this user may open: Settings → Backups, Email, Roles; deliveries; the status panel. */
+    views: {
+        status: boolean;
+        deliveries: boolean;
+        backups: boolean;
+        email: boolean;
+        roles: boolean;
+        sso: boolean;
+        audit: boolean;
+    };
+    /** Roles from the admin are on (`auth.rbac`): documents have owners. */
+    rbac: boolean;
+    /** Outside accounts users can sign in with and link (`auth.providers`). */
+    providers: SsoProviderRef[];
+    /** Pages this user may open (`admin.pages`). */
+    pages: AdminPageRef[];
+    /** Dashboard panels this user may see (`admin.dashboard`). */
+    dashboard: AdminWidgetRef[];
+}
+
+/**
+ * The version of what the admin gives the Web Components of admin modules (fields, cells, side
+ * panels, pages, dashboard panels). It changes only when a component would break.
+ */
+declare const ADMIN_API_VERSION = 1;
+/** Where a page (`admin.pages`) is: what follows `/p/<path>/`, and the query's first values. */
+interface AdminPageRoute {
+    readonly subpath: string;
+    readonly query: Readonly<Record<string, string>>;
+}
+/**
+ * The properties the admin sets on a component's element. Components may dispatch:
+ *
+ * - `change` (`CustomEvent`, `detail`: the new value): sets the field's value.
+ * - `set-field` (`detail: { path, value }`): sets another field, e.g. `meta.title`.
+ * - `navigate` (`detail`: a path inside the admin, e.g. `/p/forms-overview?range=30`): goes there.
+ */
+interface AdminElementProps {
+    apiVersion: typeof ADMIN_API_VERSION;
+    /** The field's value (field components only). */
+    value: unknown;
+    /** The field's path in the document, e.g. `meta.title` (field components only). */
+    path: string | undefined;
+    field: AdminField | undefined;
+    /** The field's label in the admin's language (field components only). */
+    label: string | undefined;
+    /** The whole form as edited, not yet saved (a copy); in a list's cell, that row's document. */
+    doc: Record<string, unknown>;
+    collection: string | undefined;
+    global: string | undefined;
+    /** The document's id; `null` while creating one. */
+    id: string | number | null;
+    /** The content locale being edited (with localization), otherwise `null`. */
+    locale: string | null;
+    /** The admin's language. */
+    uiLocale: AdminLocale;
+    readOnly: boolean;
+    /** The component's `props` from the config. */
+    options: Record<string, unknown>;
+    /** Calls the REST API as the logged-in user, e.g. `api('POST', '/seo/generate', body)`. */
+    api: <T = unknown>(method: string, path: string, body?: unknown) => Promise<T>;
+    /** The logged-in user. */
+    user: {
+        id: string | number;
+        email: string;
+        role: string;
+    } | null;
+    /** On a page of its own (`admin.pages`): the rest of its path and the query; otherwise undefined. */
+    route: AdminPageRoute | undefined;
+}
+/** The `detail` of a `set-field` event. */
+interface SetFieldDetail {
+    readonly path: string;
+    readonly value: unknown;
+}
+
+export { ADMIN_API_VERSION as A, type SetFieldDetail as S, type AdminCollection as a, type AdminComponentRef as b, type AdminElementProps as c, type AdminField as d, type AdminGlobal as e, type AdminLayoutNode as f, type AdminNavGroup as g, type AdminNavItem as h, type AdminNavNode as i, type AdminPageRef as j, type AdminPageRoute as k, type AdminSchema as l, type AdminWidgetRef as m };

package/dist/plugin.d.ts

@@ -0,0 +1,3 @@
+export { a as ADMIN_ICONS, g as AdminComponent, j as AdminIcon, S as AuthUser, a3 as CliCommand, a4 as CollectionAccess, a6 as CollectionConfig, ab as Config, ac as ConfigError, ak as DashboardWidget, av as EasyCMSError, az as Endpoint, aA as EndpointRequest, aB as ErrorCode, aD as Field, aE as FieldAccess, aH as FieldError, aK as FieldTypeBase, aL as FieldTypeDefinition, aM as FieldTypeValidateContext, aY as ForbiddenError, a_ as GlobalConfig, I as ID, b8 as JobConfig, ba as Label, bl as NavGroup, bm as NotFoundError, bo as OnRequest, bp as OnRequestArgs, br as PLUGIN_API_VERSION, bw as PayloadTooLargeError, bx as Plugin, by as PluginInfo, bz as PluginTypes, bC as QueryError, bH as RequestContext, c6 as TooManyRequestsError, c7 as TypedPlugin, c8 as UnauthorizedError, cf as ValidationError, cn as Where, cu as defineFieldType, cv as definePlugin } from './config-jzFGsNL6.js';
+export { A as ADMIN_API_VERSION, c as AdminElementProps, k as AdminPageRoute, S as SetFieldDetail } from './plugin-EX9OHwR3.js';
+import './conditions.js';

package/dist/plugin.js

@@ -0,0 +1,34 @@
+import {
+  ADMIN_API_VERSION
+} from "./chunk-K6GTTRN3.js";
+import {
+  ADMIN_ICONS,
+  ConfigError,
+  EasyCMSError,
+  ForbiddenError,
+  NotFoundError,
+  PLUGIN_API_VERSION,
+  PayloadTooLargeError,
+  QueryError,
+  TooManyRequestsError,
+  UnauthorizedError,
+  ValidationError,
+  defineFieldType,
+  definePlugin
+} from "./chunk-CGVNZUW4.js";
+export {
+  ADMIN_API_VERSION,
+  ADMIN_ICONS,
+  ConfigError,
+  EasyCMSError,
+  ForbiddenError,
+  NotFoundError,
+  PLUGIN_API_VERSION,
+  PayloadTooLargeError,
+  QueryError,
+  TooManyRequestsError,
+  UnauthorizedError,
+  ValidationError,
+  defineFieldType,
+  definePlugin
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/core",
-  "version": "0.47.4",
+  "version": "0.49.0",
   "description": "Embedded, code-first headless CMS for Nuxt and Next.js",
   "license": "MIT",
   "type": "module",
@@ -18,6 +18,14 @@
       "types": "./dist/conditions.d.ts",
       "default": "./dist/conditions.js"
     },
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "default": "./dist/plugin.js"
+    },
+    "./internal": {
+      "types": "./dist/internal.d.ts",
+      "default": "./dist/internal.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [