@humaan/payload-plugin-ai-assistant 0.0.0-stage → 0.1.0

package/dist/plugin.js

@@ -0,0 +1,464 @@
+import { withAttachmentRules } from './attachments/collection.js';
+import { byokProblem, resolveByok } from './billing.js';
+import { ownerAccess } from './collectionAccess.js';
+import { aiAssistantAttachmentSlug, aiAssistantGlobalSlug, aiAssistantPlanSlug, aiAssistantThreadSlug, aiAssistantUsageSlug, assistantControlPath, budgetFieldPath, defaultDailySpendCapPercent, deniedSlugs, pageContextBridgePath, pluginCustomKey, settingsAlertsPath } from './constants.js';
+import { applyEndpoint, cancelEndpoint } from './endpoints/applyEndpoint.js';
+import { chatEndpoint } from './endpoints/chatEndpoint.js';
+import { usageEndpoint } from './endpoints/usageEndpoint.js';
+import { isAdminRole } from './settings.js';
+const adminOnly = ({ req: { user } })=>isAdminRole(user);
+/** The collection admins log in with: `admin.user`, as Payload reads it, or the first auth collection. */ function usersCollectionOf(config) {
+    const slug = config.admin?.user ?? config.collections?.find((collection)=>collection.auth)?.slug ?? 'users';
+    return slug;
+}
+function assertOptions(config, options) {
+    if (options.roles.length === 0) {
+        throw new Error('aiAssistantPlugin requires at least one role.');
+    }
+    if (!options.siteRules.trim()) {
+        throw new Error('aiAssistantPlugin requires site rules.');
+    }
+    for (const slug of Object.keys(options.collectionRules ?? {})){
+        const collection = config.collections?.some((item)=>item.slug === slug);
+        const global = config.globals?.some((item)=>item.slug === slug);
+        if (!collection && !global) {
+            throw new Error(`aiAssistantPlugin collectionRules refers to unknown target "${slug}".`);
+        }
+    }
+    // A mistyped slug would leave that collection open to the assistant, so it fails loudly instead.
+    for (const slug of options.deniedCollections ?? []){
+        if (!config.collections?.some((item)=>item.slug === slug)) {
+            throw new Error(`aiAssistantPlugin deniedCollections refers to unknown collection "${slug}".`);
+        }
+    }
+    for (const slug of options.deniedGlobals ?? []){
+        if (!config.globals?.some((item)=>item.slug === slug)) {
+            throw new Error(`aiAssistantPlugin deniedGlobals refers to unknown global "${slug}".`);
+        }
+    }
+    const byok = byokProblem(options.byok);
+    if (byok) {
+        throw new Error(`aiAssistantPlugin byok has ${byok}`);
+    }
+}
+function plansCollection(usersSlug, fallback) {
+    const owned = ownerAccess(fallback);
+    return {
+        slug: aiAssistantPlanSlug,
+        labels: {
+            singular: 'Humaan AI plan',
+            plural: 'Humaan AI plans'
+        },
+        admin: {
+            hidden: true
+        },
+        // The REST API can read and delete an editor's own plans, but not write them. Otherwise a plan could be
+        // written by hand and applied without the model or its checks.
+        access: {
+            create: ()=>false,
+            read: owned,
+            update: ()=>false,
+            delete: owned
+        },
+        fields: [
+            {
+                name: 'owner',
+                type: 'relationship',
+                relationTo: usersSlug,
+                required: true,
+                index: true
+            },
+            {
+                name: 'thread',
+                type: 'text',
+                index: true,
+                admin: {
+                    description: 'The conversation the plan was proposed in.'
+                }
+            },
+            {
+                name: 'status',
+                type: 'select',
+                required: true,
+                defaultValue: 'proposed',
+                options: [
+                    {
+                        label: 'Proposed',
+                        value: 'proposed'
+                    },
+                    {
+                        label: 'Blocked',
+                        value: 'blocked'
+                    },
+                    {
+                        label: 'Applied',
+                        value: 'applied'
+                    },
+                    {
+                        label: 'Cancelled',
+                        value: 'cancelled'
+                    }
+                ]
+            },
+            {
+                name: 'summary',
+                type: 'textarea',
+                required: true
+            },
+            {
+                name: 'plan',
+                type: 'json',
+                required: true
+            }
+        ]
+    };
+}
+/**
+ * Conversations are written only by the assistant endpoints, so the REST API can read and delete them but not edit them.
+ * An edited history could put words in the assistant's mouth.
+ */ function threadsCollection(usersSlug, fallback) {
+    const owned = ownerAccess(fallback);
+    return {
+        slug: aiAssistantThreadSlug,
+        labels: {
+            singular: 'Humaan AI conversation',
+            plural: 'Humaan AI conversations'
+        },
+        admin: {
+            hidden: true,
+            useAsTitle: 'title'
+        },
+        access: {
+            create: ()=>false,
+            read: owned,
+            update: ()=>false,
+            delete: owned
+        },
+        fields: [
+            {
+                name: 'owner',
+                type: 'relationship',
+                relationTo: usersSlug,
+                required: true,
+                index: true
+            },
+            {
+                name: 'chatId',
+                type: 'text',
+                required: true,
+                index: true
+            },
+            {
+                name: 'title',
+                type: 'text'
+            },
+            {
+                name: 'messages',
+                type: 'json'
+            },
+            {
+                name: 'files',
+                type: 'json',
+                admin: {
+                    description: 'Names and sizes of attached files. The files stay in the browser until a plan saves them.'
+                }
+            }
+        ]
+    };
+}
+/** Each editor's spend per day. Written only by the chat endpoint; editors can read their own, admins all. */ function usageCollection(usersSlug, fallback) {
+    const owned = ownerAccess(fallback);
+    return {
+        slug: aiAssistantUsageSlug,
+        labels: {
+            singular: 'Humaan AI usage',
+            plural: 'Humaan AI usage'
+        },
+        admin: {
+            hidden: true
+        },
+        access: {
+            create: ()=>false,
+            read: async (args)=>isAdminRole(args.req.user) ? true : owned(args),
+            update: ()=>false,
+            delete: ()=>false
+        },
+        fields: [
+            {
+                name: 'owner',
+                type: 'relationship',
+                relationTo: usersSlug,
+                required: true,
+                index: true
+            },
+            {
+                name: 'day',
+                type: 'text',
+                required: true,
+                index: true,
+                admin: {
+                    description: "YYYY-MM-DD in the site's time zone."
+                }
+            },
+            {
+                name: 'costUsd',
+                type: 'number',
+                required: true,
+                defaultValue: 0,
+                admin: {
+                    description: "Billed to Vercel's credit."
+                }
+            },
+            {
+                name: 'ownKeyCostUsd',
+                type: 'number',
+                required: true,
+                defaultValue: 0,
+                admin: {
+                    description: "Billed to the site's own provider key."
+                }
+            },
+            {
+                name: 'fallbackSteps',
+                type: 'number',
+                required: true,
+                defaultValue: 0,
+                admin: {
+                    description: "Calls meant for the own key that ran on Vercel's credit."
+                }
+            },
+            {
+                name: 'tokens',
+                type: 'number',
+                required: true,
+                defaultValue: 0
+            },
+            {
+                name: 'replies',
+                type: 'number',
+                required: true,
+                defaultValue: 0
+            }
+        ]
+    };
+}
+/** Lets the drawer in the header know which document is open, and read its unsaved form values. */ function withPageContext(entity, kind) {
+    const denied = new Set(deniedSlugs);
+    if (denied.has(entity.slug) || 'auth' in entity && entity.auth) {
+        return entity;
+    }
+    const admin = entity.admin ?? {};
+    const components = admin.components ?? {};
+    if (kind === 'collection') {
+        const edit = components.edit ?? {};
+        return {
+            ...entity,
+            admin: {
+                ...admin,
+                components: {
+                    ...components,
+                    edit: {
+                        ...edit,
+                        beforeDocumentControls: [
+                            ...edit.beforeDocumentControls ?? [],
+                            pageContextBridgePath
+                        ]
+                    }
+                }
+            }
+        };
+    }
+    const elements = components.elements ?? {};
+    return {
+        ...entity,
+        admin: {
+            ...admin,
+            components: {
+                ...components,
+                elements: {
+                    ...elements,
+                    beforeDocumentControls: [
+                        ...elements.beforeDocumentControls ?? [],
+                        pageContextBridgePath
+                    ]
+                }
+            }
+        }
+    };
+}
+function settingsGlobal(options, fallback, ownKey) {
+    // Without complete credentials there is no choice to make, so only Vercel shows.
+    const ownKeyAvailable = ownKey !== undefined;
+    const fields = [
+        {
+            name: 'alerts',
+            type: 'ui',
+            admin: {
+                components: {
+                    Field: settingsAlertsPath
+                }
+            }
+        },
+        {
+            name: 'billing',
+            label: 'AI Source',
+            type: 'select',
+            required: true,
+            defaultValue: fallback.billing,
+            options: [
+                {
+                    label: 'Humaan AI',
+                    value: 'vercel'
+                },
+                {
+                    label: ownKey ? `Own provider key (${ownKey.label})` : 'Own provider key',
+                    value: 'own-key'
+                }
+            ],
+            admin: {
+                hidden: !ownKeyAvailable,
+                description: 'Where replies come from. Humaan AI is managed by Humaan. With your own provider key, the provider bills the account that owns the key, and the daily spend cap does not apply. If the key stops working, replies continue through Humaan AI.'
+            }
+        },
+        {
+            name: 'budget',
+            type: 'ui',
+            admin: {
+                components: {
+                    Field: budgetFieldPath
+                }
+            }
+        },
+        {
+            name: 'allowedRoles',
+            label: 'Who can run it',
+            type: 'select',
+            hasMany: true,
+            required: true,
+            defaultValue: fallback.allowedRoles,
+            options: options.roles
+        },
+        {
+            name: 'dailySpendCapPercent',
+            label: 'Daily spend cap per editor (% of budget)',
+            type: 'number',
+            min: 0,
+            max: 100,
+            defaultValue: fallback.dailySpendCapPercent,
+            admin: {
+                // Shares of the Vercel budget mean nothing when the provider bills the site's own key.
+                condition: ownKeyAvailable ? (data)=>data?.billing !== 'own-key' : undefined,
+                description: "The share of the project's Humaan AI budget that each editor can spend per day. Set 0 for no cap."
+            }
+        }
+    ];
+    return {
+        slug: aiAssistantGlobalSlug,
+        label: 'Humaan AI',
+        typescript: {
+            interface: 'AiAssistantGlobal'
+        },
+        admin: {
+            group: options.adminGroup ?? 'Settings'
+        },
+        access: {
+            read: adminOnly,
+            update: adminOnly
+        },
+        fields
+    };
+}
+export const aiAssistantPlugin = (options)=>(config)=>{
+        assertOptions(config, options);
+        const fallback = {
+            billing: 'vercel',
+            allowedRoles: options.roles.some((role)=>role.value === 'admin') ? [
+                'admin'
+            ] : [
+                options.roles[0].value
+            ],
+            dailySpendCapPercent: defaultDailySpendCapPercent
+        };
+        const usersSlug = usersCollectionOf(config);
+        const collections = [
+            plansCollection(usersSlug, fallback),
+            threadsCollection(usersSlug, fallback),
+            usageCollection(usersSlug, fallback)
+        ];
+        // Resolved once, when the config is built: environment variables are read in the project's config.
+        const byok = resolveByok(options.byok);
+        const global = settingsGlobal(options, fallback, byok.key);
+        // The project registers the attachments collection so its storage adapter handles the files; the rules are added here.
+        const existing = (config.collections ?? []).map((collection)=>collection.slug === aiAssistantAttachmentSlug ? withAttachmentRules(collection, usersSlug, fallback) : collection);
+        const runtime = {
+            attachmentReadParams: options.attachmentReadParams,
+            timeZone: options.timeZone ?? 'UTC',
+            // Only which providers, so the settings screen can describe the own key. The credentials stay in the endpoint.
+            ...byok.key ? {
+                ownKey: {
+                    providers: byok.key.providers,
+                    label: byok.key.label
+                }
+            } : {},
+            ownKeyIncomplete: byok.incomplete,
+            deniedCollections: options.deniedCollections ?? [],
+            deniedGlobals: options.deniedGlobals ?? []
+        };
+        const custom = {
+            ...config.custom,
+            [pluginCustomKey]: runtime
+        };
+        // Disabled: keep the schema, so turning the assistant back on needs no migration, but add nothing editors see.
+        if (options.enabled === false) {
+            return {
+                ...config,
+                custom,
+                collections: [
+                    ...existing,
+                    ...collections
+                ],
+                globals: [
+                    ...config.globals ?? [],
+                    global
+                ]
+            };
+        }
+        const admin = config.admin ?? {};
+        const components = admin.components ?? {};
+        return {
+            ...config,
+            custom,
+            admin: {
+                ...admin,
+                components: {
+                    ...components,
+                    actions: [
+                        ...components.actions ?? [],
+                        {
+                            path: assistantControlPath,
+                            serverProps: {
+                                fallbackSettings: fallback
+                            }
+                        }
+                    ]
+                }
+            },
+            collections: [
+                ...existing.map((collection)=>withPageContext(collection, 'collection')),
+                ...collections
+            ],
+            globals: [
+                ...(config.globals ?? []).map((entity)=>withPageContext(entity, 'global')),
+                global
+            ],
+            endpoints: [
+                ...config.endpoints ?? [],
+                chatEndpoint(options, fallback, byok.key),
+                applyEndpoint(fallback),
+                cancelEndpoint(fallback),
+                usageEndpoint(fallback, options, byok.key)
+            ]
+        };
+    };
+
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type {\n  Access,\n  CollectionConfig,\n  CollectionSlug,\n  Config,\n  Field,\n  GlobalConfig,\n  Plugin,\n} from 'payload'\n\nimport type { OwnKey } from './billing.js'\nimport type { PluginRuntime } from './runtime.js'\nimport type { AiAssistantPluginOptions, AssistantSettings } from './types.js'\n\nimport { withAttachmentRules } from './attachments/collection.js'\nimport { byokProblem, resolveByok } from './billing.js'\nimport { ownerAccess } from './collectionAccess.js'\nimport {\n  aiAssistantAttachmentSlug,\n  aiAssistantGlobalSlug,\n  aiAssistantPlanSlug,\n  aiAssistantThreadSlug,\n  aiAssistantUsageSlug,\n  assistantControlPath,\n  budgetFieldPath,\n  defaultDailySpendCapPercent,\n  deniedSlugs,\n  pageContextBridgePath,\n  pluginCustomKey,\n  settingsAlertsPath,\n} from './constants.js'\nimport { applyEndpoint, cancelEndpoint } from './endpoints/applyEndpoint.js'\nimport { chatEndpoint } from './endpoints/chatEndpoint.js'\nimport { usageEndpoint } from './endpoints/usageEndpoint.js'\nimport { isAdminRole } from './settings.js'\n\nconst adminOnly: Access = ({ req: { user } }) => isAdminRole(user)\n\n/** The collection admins log in with: `admin.user`, as Payload reads it, or the first auth collection. */\nfunction usersCollectionOf(config: Config): CollectionSlug {\n  const slug =\n    config.admin?.user ?? config.collections?.find((collection) => collection.auth)?.slug ?? 'users'\n  return slug as CollectionSlug\n}\n\nfunction assertOptions(config: Config, options: AiAssistantPluginOptions): void {\n  if (options.roles.length === 0) {\n    throw new Error('aiAssistantPlugin requires at least one role.')\n  }\n  if (!options.siteRules.trim()) {\n    throw new Error('aiAssistantPlugin requires site rules.')\n  }\n  for (const slug of Object.keys(options.collectionRules ?? {})) {\n    const collection = config.collections?.some((item) => item.slug === slug)\n    const global = config.globals?.some((item) => item.slug === slug)\n    if (!collection && !global) {\n      throw new Error(`aiAssistantPlugin collectionRules refers to unknown target \"${slug}\".`)\n    }\n  }\n  // A mistyped slug would leave that collection open to the assistant, so it fails loudly instead.\n  for (const slug of options.deniedCollections ?? []) {\n    if (!config.collections?.some((item) => item.slug === slug)) {\n      throw new Error(`aiAssistantPlugin deniedCollections refers to unknown collection \"${slug}\".`)\n    }\n  }\n  for (const slug of options.deniedGlobals ?? []) {\n    if (!config.globals?.some((item) => item.slug === slug)) {\n      throw new Error(`aiAssistantPlugin deniedGlobals refers to unknown global \"${slug}\".`)\n    }\n  }\n  const byok = byokProblem(options.byok)\n  if (byok) {\n    throw new Error(`aiAssistantPlugin byok has ${byok}`)\n  }\n}\n\nfunction plansCollection(usersSlug: CollectionSlug, fallback: AssistantSettings): CollectionConfig {\n  const owned = ownerAccess(fallback)\n\n  return {\n    slug: aiAssistantPlanSlug,\n    labels: { singular: 'Humaan AI plan', plural: 'Humaan AI plans' },\n    admin: { hidden: true },\n    // The REST API can read and delete an editor's own plans, but not write them. Otherwise a plan could be\n    // written by hand and applied without the model or its checks.\n    access: {\n      create: () => false,\n      read: owned,\n      update: () => false,\n      delete: owned,\n    },\n    fields: [\n      {\n        name: 'owner',\n        type: 'relationship',\n        relationTo: usersSlug,\n        required: true,\n        index: true,\n      },\n      {\n        name: 'thread',\n        type: 'text',\n        index: true,\n        admin: { description: 'The conversation the plan was proposed in.' },\n      },\n      {\n        name: 'status',\n        type: 'select',\n        required: true,\n        defaultValue: 'proposed',\n        options: [\n          { label: 'Proposed', value: 'proposed' },\n          { label: 'Blocked', value: 'blocked' },\n          { label: 'Applied', value: 'applied' },\n          { label: 'Cancelled', value: 'cancelled' },\n        ],\n      },\n      { name: 'summary', type: 'textarea', required: true },\n      { name: 'plan', type: 'json', required: true },\n    ],\n  }\n}\n\n/**\n * Conversations are written only by the assistant endpoints, so the REST API can read and delete them but not edit them.\n * An edited history could put words in the assistant's mouth.\n */\nfunction threadsCollection(\n  usersSlug: CollectionSlug,\n  fallback: AssistantSettings,\n): CollectionConfig {\n  const owned = ownerAccess(fallback)\n\n  return {\n    slug: aiAssistantThreadSlug,\n    labels: { singular: 'Humaan AI conversation', plural: 'Humaan AI conversations' },\n    admin: { hidden: true, useAsTitle: 'title' },\n    access: {\n      create: () => false,\n      read: owned,\n      update: () => false,\n      delete: owned,\n    },\n    fields: [\n      {\n        name: 'owner',\n        type: 'relationship',\n        relationTo: usersSlug,\n        required: true,\n        index: true,\n      },\n      {\n        name: 'chatId',\n        type: 'text',\n        required: true,\n        index: true,\n      },\n      { name: 'title', type: 'text' },\n      { name: 'messages', type: 'json' },\n      {\n        name: 'files',\n        type: 'json',\n        admin: {\n          description:\n            'Names and sizes of attached files. The files stay in the browser until a plan saves them.',\n        },\n      },\n    ],\n  }\n}\n\n/** Each editor's spend per day. Written only by the chat endpoint; editors can read their own, admins all. */\nfunction usageCollection(usersSlug: CollectionSlug, fallback: AssistantSettings): CollectionConfig {\n  const owned = ownerAccess(fallback)\n  return {\n    slug: aiAssistantUsageSlug,\n    labels: { singular: 'Humaan AI usage', plural: 'Humaan AI usage' },\n    admin: { hidden: true },\n    access: {\n      create: () => false,\n      read: async (args) => (isAdminRole(args.req.user) ? true : owned(args)),\n      update: () => false,\n      delete: () => false,\n    },\n    fields: [\n      { name: 'owner', type: 'relationship', relationTo: usersSlug, required: true, index: true },\n      {\n        name: 'day',\n        type: 'text',\n        required: true,\n        index: true,\n        admin: { description: \"YYYY-MM-DD in the site's time zone.\" },\n      },\n      {\n        name: 'costUsd',\n        type: 'number',\n        required: true,\n        defaultValue: 0,\n        admin: { description: \"Billed to Vercel's credit.\" },\n      },\n      {\n        name: 'ownKeyCostUsd',\n        type: 'number',\n        required: true,\n        defaultValue: 0,\n        admin: { description: \"Billed to the site's own provider key.\" },\n      },\n      {\n        name: 'fallbackSteps',\n        type: 'number',\n        required: true,\n        defaultValue: 0,\n        admin: { description: \"Calls meant for the own key that ran on Vercel's credit.\" },\n      },\n      { name: 'tokens', type: 'number', required: true, defaultValue: 0 },\n      { name: 'replies', type: 'number', required: true, defaultValue: 0 },\n    ],\n  }\n}\n\n/** Lets the drawer in the header know which document is open, and read its unsaved form values. */\nfunction withPageContext<T extends CollectionConfig | GlobalConfig>(\n  entity: T,\n  kind: 'collection' | 'global',\n): T {\n  const denied = new Set<string>(deniedSlugs)\n  if (denied.has(entity.slug) || ('auth' in entity && entity.auth)) {\n    return entity\n  }\n  const admin = entity.admin ?? {}\n  const components = admin.components ?? {}\n  if (kind === 'collection') {\n    const edit =\n      (components as NonNullable<NonNullable<CollectionConfig['admin']>['components']>).edit ?? {}\n    return {\n      ...entity,\n      admin: {\n        ...admin,\n        components: {\n          ...components,\n          edit: {\n            ...edit,\n            beforeDocumentControls: [...(edit.beforeDocumentControls ?? []), pageContextBridgePath],\n          },\n        },\n      },\n    }\n  }\n  const elements =\n    (components as NonNullable<NonNullable<GlobalConfig['admin']>['components']>).elements ?? {}\n  return {\n    ...entity,\n    admin: {\n      ...admin,\n      components: {\n        ...components,\n        elements: {\n          ...elements,\n          beforeDocumentControls: [\n            ...(elements.beforeDocumentControls ?? []),\n            pageContextBridgePath,\n          ],\n        },\n      },\n    },\n  }\n}\n\nfunction settingsGlobal(\n  options: AiAssistantPluginOptions,\n  fallback: AssistantSettings,\n  ownKey: OwnKey | undefined,\n): GlobalConfig {\n  // Without complete credentials there is no choice to make, so only Vercel shows.\n  const ownKeyAvailable = ownKey !== undefined\n  const fields: Field[] = [\n    {\n      name: 'alerts',\n      type: 'ui',\n      admin: {\n        components: {\n          Field: settingsAlertsPath,\n        },\n      },\n    },\n    {\n      name: 'billing',\n      label: 'AI Source',\n      type: 'select',\n      required: true,\n      defaultValue: fallback.billing,\n      options: [\n        { label: 'Humaan AI', value: 'vercel' },\n        {\n          label: ownKey ? `Own provider key (${ownKey.label})` : 'Own provider key',\n          value: 'own-key',\n        },\n      ],\n      admin: {\n        hidden: !ownKeyAvailable,\n        description:\n          'Where replies come from. Humaan AI is managed by Humaan. With your own provider key, the provider bills the account that owns the key, and the daily spend cap does not apply. If the key stops working, replies continue through Humaan AI.',\n      },\n    },\n    {\n      name: 'budget',\n      type: 'ui',\n      admin: {\n        components: {\n          Field: budgetFieldPath,\n        },\n      },\n    },\n    {\n      name: 'allowedRoles',\n      label: 'Who can run it',\n      type: 'select',\n      hasMany: true,\n      required: true,\n      defaultValue: fallback.allowedRoles,\n      options: options.roles,\n    },\n    {\n      name: 'dailySpendCapPercent',\n      label: 'Daily spend cap per editor (% of budget)',\n      type: 'number',\n      min: 0,\n      max: 100,\n      defaultValue: fallback.dailySpendCapPercent,\n      admin: {\n        // Shares of the Vercel budget mean nothing when the provider bills the site's own key.\n        condition: ownKeyAvailable ? (data) => data?.billing !== 'own-key' : undefined,\n        description:\n          \"The share of the project's Humaan AI budget that each editor can spend per day. Set 0 for no cap.\",\n      },\n    },\n  ]\n\n  return {\n    slug: aiAssistantGlobalSlug,\n    label: 'Humaan AI',\n    typescript: { interface: 'AiAssistantGlobal' },\n    admin: { group: options.adminGroup ?? 'Settings' },\n    access: {\n      read: adminOnly,\n      update: adminOnly,\n    },\n    fields,\n  }\n}\n\nexport const aiAssistantPlugin =\n  (options: AiAssistantPluginOptions): Plugin =>\n  (config: Config): Config => {\n    assertOptions(config, options)\n\n    const fallback: AssistantSettings = {\n      billing: 'vercel',\n      allowedRoles: options.roles.some((role) => role.value === 'admin')\n        ? ['admin']\n        : [options.roles[0].value],\n      dailySpendCapPercent: defaultDailySpendCapPercent,\n    }\n    const usersSlug = usersCollectionOf(config)\n    const collections = [\n      plansCollection(usersSlug, fallback),\n      threadsCollection(usersSlug, fallback),\n      usageCollection(usersSlug, fallback),\n    ]\n    // Resolved once, when the config is built: environment variables are read in the project's config.\n    const byok = resolveByok(options.byok)\n    const global = settingsGlobal(options, fallback, byok.key)\n    // The project registers the attachments collection so its storage adapter handles the files; the rules are added here.\n    const existing = (config.collections ?? []).map((collection) =>\n      collection.slug === aiAssistantAttachmentSlug\n        ? withAttachmentRules(collection, usersSlug, fallback)\n        : collection,\n    )\n\n    const runtime: PluginRuntime = {\n      attachmentReadParams: options.attachmentReadParams,\n      timeZone: options.timeZone ?? 'UTC',\n      // Only which providers, so the settings screen can describe the own key. The credentials stay in the endpoint.\n      ...(byok.key ? { ownKey: { providers: byok.key.providers, label: byok.key.label } } : {}),\n      ownKeyIncomplete: byok.incomplete,\n      deniedCollections: options.deniedCollections ?? [],\n      deniedGlobals: options.deniedGlobals ?? [],\n    }\n    const custom = { ...config.custom, [pluginCustomKey]: runtime }\n\n    // Disabled: keep the schema, so turning the assistant back on needs no migration, but add nothing editors see.\n    if (options.enabled === false) {\n      return {\n        ...config,\n        custom,\n        collections: [...existing, ...collections],\n        globals: [...(config.globals ?? []), global],\n      }\n    }\n\n    const admin = config.admin ?? {}\n    const components = admin.components ?? {}\n    return {\n      ...config,\n      custom,\n      admin: {\n        ...admin,\n        components: {\n          ...components,\n          actions: [\n            ...(components.actions ?? []),\n            {\n              path: assistantControlPath,\n              serverProps: { fallbackSettings: fallback },\n            },\n          ],\n        },\n      },\n      collections: [\n        ...existing.map((collection) => withPageContext(collection, 'collection')),\n        ...collections,\n      ],\n      globals: [\n        ...(config.globals ?? []).map((entity) => withPageContext(entity, 'global')),\n        global,\n      ],\n      endpoints: [\n        ...(config.endpoints ?? []),\n        chatEndpoint(options, fallback, byok.key),\n        applyEndpoint(fallback),\n        cancelEndpoint(fallback),\n        usageEndpoint(fallback, options, byok.key),\n      ],\n    }\n  }\n"],"names":["withAttachmentRules","byokProblem","resolveByok","ownerAccess","aiAssistantAttachmentSlug","aiAssistantGlobalSlug","aiAssistantPlanSlug","aiAssistantThreadSlug","aiAssistantUsageSlug","assistantControlPath","budgetFieldPath","defaultDailySpendCapPercent","deniedSlugs","pageContextBridgePath","pluginCustomKey","settingsAlertsPath","applyEndpoint","cancelEndpoint","chatEndpoint","usageEndpoint","isAdminRole","adminOnly","req","user","usersCollectionOf","config","slug","admin","collections","find","collection","auth","assertOptions","options","roles","length","Error","siteRules","trim","Object","keys","collectionRules","some","item","global","globals","deniedCollections","deniedGlobals","byok","plansCollection","usersSlug","fallback","owned","labels","singular","plural","hidden","access","create","read","update","delete","fields","name","type","relationTo","required","index","description","defaultValue","label","value","threadsCollection","useAsTitle","usageCollection","args","withPageContext","entity","kind","denied","Set","has","components","edit","beforeDocumentControls","elements","settingsGlobal","ownKey","ownKeyAvailable","undefined","Field","billing","hasMany","allowedRoles","min","max","dailySpendCapPercent","condition","data","typescript","interface","group","adminGroup","aiAssistantPlugin","role","key","existing","map","runtime","attachmentReadParams","timeZone","providers","ownKeyIncomplete","incomplete","custom","enabled","actions","path","serverProps","fallbackSettings","endpoints"],"mappings":"AAcA,SAASA,mBAAmB,QAAQ,8BAA6B;AACjE,SAASC,WAAW,EAAEC,WAAW,QAAQ,eAAc;AACvD,SAASC,WAAW,QAAQ,wBAAuB;AACnD,SACEC,yBAAyB,EACzBC,qBAAqB,EACrBC,mBAAmB,EACnBC,qBAAqB,EACrBC,oBAAoB,EACpBC,oBAAoB,EACpBC,eAAe,EACfC,2BAA2B,EAC3BC,WAAW,EACXC,qBAAqB,EACrBC,eAAe,EACfC,kBAAkB,QACb,iBAAgB;AACvB,SAASC,aAAa,EAAEC,cAAc,QAAQ,+BAA8B;AAC5E,SAASC,YAAY,QAAQ,8BAA6B;AAC1D,SAASC,aAAa,QAAQ,+BAA8B;AAC5D,SAASC,WAAW,QAAQ,gBAAe;AAE3C,MAAMC,YAAoB,CAAC,EAAEC,KAAK,EAAEC,IAAI,EAAE,EAAE,GAAKH,YAAYG;AAE7D,wGAAwG,GACxG,SAASC,kBAAkBC,MAAc;IACvC,MAAMC,OACJD,OAAOE,KAAK,EAAEJ,QAAQE,OAAOG,WAAW,EAAEC,KAAK,CAACC,aAAeA,WAAWC,IAAI,GAAGL,QAAQ;IAC3F,OAAOA;AACT;AAEA,SAASM,cAAcP,MAAc,EAAEQ,OAAiC;IACtE,IAAIA,QAAQC,KAAK,CAACC,MAAM,KAAK,GAAG;QAC9B,MAAM,IAAIC,MAAM;IAClB;IACA,IAAI,CAACH,QAAQI,SAAS,CAACC,IAAI,IAAI;QAC7B,MAAM,IAAIF,MAAM;IAClB;IACA,KAAK,MAAMV,QAAQa,OAAOC,IAAI,CAACP,QAAQQ,eAAe,IAAI,CAAC,GAAI;QAC7D,MAAMX,aAAaL,OAAOG,WAAW,EAAEc,KAAK,CAACC,OAASA,KAAKjB,IAAI,KAAKA;QACpE,MAAMkB,SAASnB,OAAOoB,OAAO,EAAEH,KAAK,CAACC,OAASA,KAAKjB,IAAI,KAAKA;QAC5D,IAAI,CAACI,cAAc,CAACc,QAAQ;YAC1B,MAAM,IAAIR,MAAM,CAAC,4DAA4D,EAAEV,KAAK,EAAE,CAAC;QACzF;IACF;IACA,iGAAiG;IACjG,KAAK,MAAMA,QAAQO,QAAQa,iBAAiB,IAAI,EAAE,CAAE;QAClD,IAAI,CAACrB,OAAOG,WAAW,EAAEc,KAAK,CAACC,OAASA,KAAKjB,IAAI,KAAKA,OAAO;YAC3D,MAAM,IAAIU,MAAM,CAAC,kEAAkE,EAAEV,KAAK,EAAE,CAAC;QAC/F;IACF;IACA,KAAK,MAAMA,QAAQO,QAAQc,aAAa,IAAI,EAAE,CAAE;QAC9C,IAAI,CAACtB,OAAOoB,OAAO,EAAEH,KAAK,CAACC,OAASA,KAAKjB,IAAI,KAAKA,OAAO;YACvD,MAAM,IAAIU,MAAM,CAAC,0DAA0D,EAAEV,KAAK,EAAE,CAAC;QACvF;IACF;IACA,MAAMsB,OAAO/C,YAAYgC,QAAQe,IAAI;IACrC,IAAIA,MAAM;QACR,MAAM,IAAIZ,MAAM,CAAC,2BAA2B,EAAEY,MAAM;IACtD;AACF;AAEA,SAASC,gBAAgBC,SAAyB,EAAEC,QAA2B;IAC7E,MAAMC,QAAQjD,YAAYgD;IAE1B,OAAO;QACLzB,MAAMpB;QACN+C,QAAQ;YAAEC,UAAU;YAAkBC,QAAQ;QAAkB;QAChE5B,OAAO;YAAE6B,QAAQ;QAAK;QACtB,wGAAwG;QACxG,+DAA+D;QAC/DC,QAAQ;YACNC,QAAQ,IAAM;YACdC,MAAMP;YACNQ,QAAQ,IAAM;YACdC,QAAQT;QACV;QACAU,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;gBACNC,YAAYf;gBACZgB,UAAU;gBACVC,OAAO;YACT;YACA;gBACEJ,MAAM;gBACNC,MAAM;gBACNG,OAAO;gBACPxC,OAAO;oBAAEyC,aAAa;gBAA6C;YACrE;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNE,UAAU;gBACVG,cAAc;gBACdpC,SAAS;oBACP;wBAAEqC,OAAO;wBAAYC,OAAO;oBAAW;oBACvC;wBAAED,OAAO;wBAAWC,OAAO;oBAAU;oBACrC;wBAAED,OAAO;wBAAWC,OAAO;oBAAU;oBACrC;wBAAED,OAAO;wBAAaC,OAAO;oBAAY;iBAC1C;YACH;YACA;gBAAER,MAAM;gBAAWC,MAAM;gBAAYE,UAAU;YAAK;YACpD;gBAAEH,MAAM;gBAAQC,MAAM;gBAAQE,UAAU;YAAK;SAC9C;IACH;AACF;AAEA;;;CAGC,GACD,SAASM,kBACPtB,SAAyB,EACzBC,QAA2B;IAE3B,MAAMC,QAAQjD,YAAYgD;IAE1B,OAAO;QACLzB,MAAMnB;QACN8C,QAAQ;YAAEC,UAAU;YAA0BC,QAAQ;QAA0B;QAChF5B,OAAO;YAAE6B,QAAQ;YAAMiB,YAAY;QAAQ;QAC3ChB,QAAQ;YACNC,QAAQ,IAAM;YACdC,MAAMP;YACNQ,QAAQ,IAAM;YACdC,QAAQT;QACV;QACAU,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;gBACNC,YAAYf;gBACZgB,UAAU;gBACVC,OAAO;YACT;YACA;gBACEJ,MAAM;gBACNC,MAAM;gBACNE,UAAU;gBACVC,OAAO;YACT;YACA;gBAAEJ,MAAM;gBAASC,MAAM;YAAO;YAC9B;gBAAED,MAAM;gBAAYC,MAAM;YAAO;YACjC;gBACED,MAAM;gBACNC,MAAM;gBACNrC,OAAO;oBACLyC,aACE;gBACJ;YACF;SACD;IACH;AACF;AAEA,4GAA4G,GAC5G,SAASM,gBAAgBxB,SAAyB,EAAEC,QAA2B;IAC7E,MAAMC,QAAQjD,YAAYgD;IAC1B,OAAO;QACLzB,MAAMlB;QACN6C,QAAQ;YAAEC,UAAU;YAAmBC,QAAQ;QAAkB;QACjE5B,OAAO;YAAE6B,QAAQ;QAAK;QACtBC,QAAQ;YACNC,QAAQ,IAAM;YACdC,MAAM,OAAOgB,OAAUvD,YAAYuD,KAAKrD,GAAG,CAACC,IAAI,IAAI,OAAO6B,MAAMuB;YACjEf,QAAQ,IAAM;YACdC,QAAQ,IAAM;QAChB;QACAC,QAAQ;YACN;gBAAEC,MAAM;gBAASC,MAAM;gBAAgBC,YAAYf;gBAAWgB,UAAU;gBAAMC,OAAO;YAAK;YAC1F;gBACEJ,MAAM;gBACNC,MAAM;gBACNE,UAAU;gBACVC,OAAO;gBACPxC,OAAO;oBAAEyC,aAAa;gBAAsC;YAC9D;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNE,UAAU;gBACVG,cAAc;gBACd1C,OAAO;oBAAEyC,aAAa;gBAA6B;YACrD;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNE,UAAU;gBACVG,cAAc;gBACd1C,OAAO;oBAAEyC,aAAa;gBAAyC;YACjE;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNE,UAAU;gBACVG,cAAc;gBACd1C,OAAO;oBAAEyC,aAAa;gBAA2D;YACnF;YACA;gBAAEL,MAAM;gBAAUC,MAAM;gBAAUE,UAAU;gBAAMG,cAAc;YAAE;YAClE;gBAAEN,MAAM;gBAAWC,MAAM;gBAAUE,UAAU;gBAAMG,cAAc;YAAE;SACpE;IACH;AACF;AAEA,iGAAiG,GACjG,SAASO,gBACPC,MAAS,EACTC,IAA6B;IAE7B,MAAMC,SAAS,IAAIC,IAAYpE;IAC/B,IAAImE,OAAOE,GAAG,CAACJ,OAAOnD,IAAI,KAAM,UAAUmD,UAAUA,OAAO9C,IAAI,EAAG;QAChE,OAAO8C;IACT;IACA,MAAMlD,QAAQkD,OAAOlD,KAAK,IAAI,CAAC;IAC/B,MAAMuD,aAAavD,MAAMuD,UAAU,IAAI,CAAC;IACxC,IAAIJ,SAAS,cAAc;QACzB,MAAMK,OACJ,AAACD,WAAiFC,IAAI,IAAI,CAAC;QAC7F,OAAO;YACL,GAAGN,MAAM;YACTlD,OAAO;gBACL,GAAGA,KAAK;gBACRuD,YAAY;oBACV,GAAGA,UAAU;oBACbC,MAAM;wBACJ,GAAGA,IAAI;wBACPC,wBAAwB;+BAAKD,KAAKC,sBAAsB,IAAI,EAAE;4BAAGvE;yBAAsB;oBACzF;gBACF;YACF;QACF;IACF;IACA,MAAMwE,WACJ,AAACH,WAA6EG,QAAQ,IAAI,CAAC;IAC7F,OAAO;QACL,GAAGR,MAAM;QACTlD,OAAO;YACL,GAAGA,KAAK;YACRuD,YAAY;gBACV,GAAGA,UAAU;gBACbG,UAAU;oBACR,GAAGA,QAAQ;oBACXD,wBAAwB;2BAClBC,SAASD,sBAAsB,IAAI,EAAE;wBACzCvE;qBACD;gBACH;YACF;QACF;IACF;AACF;AAEA,SAASyE,eACPrD,OAAiC,EACjCkB,QAA2B,EAC3BoC,MAA0B;IAE1B,iFAAiF;IACjF,MAAMC,kBAAkBD,WAAWE;IACnC,MAAM3B,SAAkB;QACtB;YACEC,MAAM;YACNC,MAAM;YACNrC,OAAO;gBACLuD,YAAY;oBACVQ,OAAO3E;gBACT;YACF;QACF;QACA;YACEgD,MAAM;YACNO,OAAO;YACPN,MAAM;YACNE,UAAU;YACVG,cAAclB,SAASwC,OAAO;YAC9B1D,SAAS;gBACP;oBAAEqC,OAAO;oBAAaC,OAAO;gBAAS;gBACtC;oBACED,OAAOiB,SAAS,CAAC,kBAAkB,EAAEA,OAAOjB,KAAK,CAAC,CAAC,CAAC,GAAG;oBACvDC,OAAO;gBACT;aACD;YACD5C,OAAO;gBACL6B,QAAQ,CAACgC;gBACTpB,aACE;YACJ;QACF;QACA;YACEL,MAAM;YACNC,MAAM;YACNrC,OAAO;gBACLuD,YAAY;oBACVQ,OAAOhF;gBACT;YACF;QACF;QACA;YACEqD,MAAM;YACNO,OAAO;YACPN,MAAM;YACN4B,SAAS;YACT1B,UAAU;YACVG,cAAclB,SAAS0C,YAAY;YACnC5D,SAASA,QAAQC,KAAK;QACxB;QACA;YACE6B,MAAM;YACNO,OAAO;YACPN,MAAM;YACN8B,KAAK;YACLC,KAAK;YACL1B,cAAclB,SAAS6C,oBAAoB;YAC3CrE,OAAO;gBACL,uFAAuF;gBACvFsE,WAAWT,kBAAkB,CAACU,OAASA,MAAMP,YAAY,YAAYF;gBACrErB,aACE;YACJ;QACF;KACD;IAED,OAAO;QACL1C,MAAMrB;QACNiE,OAAO;QACP6B,YAAY;YAAEC,WAAW;QAAoB;QAC7CzE,OAAO;YAAE0E,OAAOpE,QAAQqE,UAAU,IAAI;QAAW;QACjD7C,QAAQ;YACNE,MAAMtC;YACNuC,QAAQvC;QACV;QACAyC;IACF;AACF;AAEA,OAAO,MAAMyC,oBACX,CAACtE,UACD,CAACR;QACCO,cAAcP,QAAQQ;QAEtB,MAAMkB,WAA8B;YAClCwC,SAAS;YACTE,cAAc5D,QAAQC,KAAK,CAACQ,IAAI,CAAC,CAAC8D,OAASA,KAAKjC,KAAK,KAAK,WACtD;gBAAC;aAAQ,GACT;gBAACtC,QAAQC,KAAK,CAAC,EAAE,CAACqC,KAAK;aAAC;YAC5ByB,sBAAsBrF;QACxB;QACA,MAAMuC,YAAY1B,kBAAkBC;QACpC,MAAMG,cAAc;YAClBqB,gBAAgBC,WAAWC;YAC3BqB,kBAAkBtB,WAAWC;YAC7BuB,gBAAgBxB,WAAWC;SAC5B;QACD,mGAAmG;QACnG,MAAMH,OAAO9C,YAAY+B,QAAQe,IAAI;QACrC,MAAMJ,SAAS0C,eAAerD,SAASkB,UAAUH,KAAKyD,GAAG;QACzD,uHAAuH;QACvH,MAAMC,WAAW,AAACjF,CAAAA,OAAOG,WAAW,IAAI,EAAE,AAAD,EAAG+E,GAAG,CAAC,CAAC7E,aAC/CA,WAAWJ,IAAI,KAAKtB,4BAChBJ,oBAAoB8B,YAAYoB,WAAWC,YAC3CrB;QAGN,MAAM8E,UAAyB;YAC7BC,sBAAsB5E,QAAQ4E,oBAAoB;YAClDC,UAAU7E,QAAQ6E,QAAQ,IAAI;YAC9B,+GAA+G;YAC/G,GAAI9D,KAAKyD,GAAG,GAAG;gBAAElB,QAAQ;oBAAEwB,WAAW/D,KAAKyD,GAAG,CAACM,SAAS;oBAAEzC,OAAOtB,KAAKyD,GAAG,CAACnC,KAAK;gBAAC;YAAE,IAAI,CAAC,CAAC;YACxF0C,kBAAkBhE,KAAKiE,UAAU;YACjCnE,mBAAmBb,QAAQa,iBAAiB,IAAI,EAAE;YAClDC,eAAed,QAAQc,aAAa,IAAI,EAAE;QAC5C;QACA,MAAMmE,SAAS;YAAE,GAAGzF,OAAOyF,MAAM;YAAE,CAACpG,gBAAgB,EAAE8F;QAAQ;QAE9D,+GAA+G;QAC/G,IAAI3E,QAAQkF,OAAO,KAAK,OAAO;YAC7B,OAAO;gBACL,GAAG1F,MAAM;gBACTyF;gBACAtF,aAAa;uBAAI8E;uBAAa9E;iBAAY;gBAC1CiB,SAAS;uBAAKpB,OAAOoB,OAAO,IAAI,EAAE;oBAAGD;iBAAO;YAC9C;QACF;QAEA,MAAMjB,QAAQF,OAAOE,KAAK,IAAI,CAAC;QAC/B,MAAMuD,aAAavD,MAAMuD,UAAU,IAAI,CAAC;QACxC,OAAO;YACL,GAAGzD,MAAM;YACTyF;YACAvF,OAAO;gBACL,GAAGA,KAAK;gBACRuD,YAAY;oBACV,GAAGA,UAAU;oBACbkC,SAAS;2BACHlC,WAAWkC,OAAO,IAAI,EAAE;wBAC5B;4BACEC,MAAM5G;4BACN6G,aAAa;gCAAEC,kBAAkBpE;4BAAS;wBAC5C;qBACD;gBACH;YACF;YACAvB,aAAa;mBACR8E,SAASC,GAAG,CAAC,CAAC7E,aAAe8C,gBAAgB9C,YAAY;mBACzDF;aACJ;YACDiB,SAAS;mBACJ,AAACpB,CAAAA,OAAOoB,OAAO,IAAI,EAAE,AAAD,EAAG8D,GAAG,CAAC,CAAC9B,SAAWD,gBAAgBC,QAAQ;gBAClEjC;aACD;YACD4E,WAAW;mBACL/F,OAAO+F,SAAS,IAAI,EAAE;gBAC1BtG,aAAae,SAASkB,UAAUH,KAAKyD,GAAG;gBACxCzF,cAAcmC;gBACdlC,eAAekC;gBACfhC,cAAcgC,UAAUlB,SAASe,KAAKyD,GAAG;aAC1C;QACH;IACF,EAAC"}

package/dist/read/outline.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A short view of a readable document, sent with each message so the assistant knows what is on the open page.
+ * Text is cut, each block becomes one line, and long lists are shortened. The full value is one readDocument call away.
+ */
+export declare function outline(value: unknown, depth?: number): unknown;
+/** Reads `content.content.3.title` from a document, through objects and lists. */
+export declare function valueAtReadablePath(source: unknown, path: string): unknown;

package/dist/read/outline.js

@@ -0,0 +1,70 @@
+const maxText = 240;
+const maxBlockPreview = 120;
+const maxListItems = 12;
+const maxDepth = 5;
+/**
+ * A short view of a readable document, sent with each message so the assistant knows what is on the open page.
+ * Text is cut, each block becomes one line, and long lists are shortened. The full value is one readDocument call away.
+ */ export function outline(value, depth = 0) {
+    if (typeof value === 'string') {
+        return cut(value, maxText);
+    }
+    if (depth > maxDepth) {
+        return '[more]';
+    }
+    if (Array.isArray(value)) {
+        const items = value.slice(0, maxListItems).map((item, index)=>isRecord(item) && typeof item.blockType === 'string' ? blockLine(item, index) : outline(item, depth + 1));
+        const hidden = value.length - items.length;
+        return hidden > 0 ? [
+            ...items,
+            `[${hidden} more]`
+        ] : items;
+    }
+    if (!isRecord(value)) {
+        return value;
+    }
+    return Object.fromEntries(Object.entries(value).map(([key, item])=>[
+            key,
+            outline(item, depth + 1)
+        ]));
+}
+/** `3: accordionGroup "FAQ" – Why should I choose Storco? …` */ function blockLine(block, index) {
+    const name = typeof block.blockName === 'string' && block.blockName ? ` "${block.blockName}"` : '';
+    const preview = firstText(block);
+    return `${index}: ${String(block.blockType)}${name}${preview ? ` – ${cut(preview, maxBlockPreview)}` : ''}`;
+}
+/** The first readable words in a block, skipping ids and other short codes. */ function firstText(value) {
+    if (typeof value === 'string') {
+        const text = value.replace(/\s+/g, ' ').trim();
+        return text.includes(' ') ? text : undefined;
+    }
+    const items = Array.isArray(value) ? value : isRecord(value) ? Object.entries(value).filter(([key])=>key !== 'id' && key !== 'blockType').map(([, item])=>item) : [];
+    for (const item of items){
+        const found = firstText(item);
+        if (found) {
+            return found;
+        }
+    }
+    return undefined;
+}
+/** Reads `content.content.3.title` from a document, through objects and lists. */ export function valueAtReadablePath(source, path) {
+    let current = source;
+    for (const key of path.split('.').filter(Boolean)){
+        if (Array.isArray(current) && /^\d+$/.test(key)) {
+            current = current[Number(key)];
+        } else if (isRecord(current)) {
+            current = current[key];
+        } else {
+            return undefined;
+        }
+    }
+    return current;
+}
+function cut(value, limit) {
+    return value.length > limit ? `${value.slice(0, limit)}…` : value;
+}
+function isRecord(value) {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+}
+
+//# sourceMappingURL=outline.js.map

package/dist/read/outline.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/read/outline.ts"],"sourcesContent":["const maxText = 240\nconst maxBlockPreview = 120\nconst maxListItems = 12\nconst maxDepth = 5\n\n/**\n * A short view of a readable document, sent with each message so the assistant knows what is on the open page.\n * Text is cut, each block becomes one line, and long lists are shortened. The full value is one readDocument call away.\n */\nexport function outline(value: unknown, depth = 0): unknown {\n  if (typeof value === 'string') {\n    return cut(value, maxText)\n  }\n  if (depth > maxDepth) {\n    return '[more]'\n  }\n  if (Array.isArray(value)) {\n    const items = value\n      .slice(0, maxListItems)\n      .map((item, index) =>\n        isRecord(item) && typeof item.blockType === 'string'\n          ? blockLine(item, index)\n          : outline(item, depth + 1),\n      )\n    const hidden = value.length - items.length\n    return hidden > 0 ? [...items, `[${hidden} more]`] : items\n  }\n  if (!isRecord(value)) {\n    return value\n  }\n  return Object.fromEntries(\n    Object.entries(value).map(([key, item]) => [key, outline(item, depth + 1)]),\n  )\n}\n\n/** `3: accordionGroup \"FAQ\" – Why should I choose Storco? …` */\nfunction blockLine(block: Record<string, unknown>, index: number): string {\n  const name = typeof block.blockName === 'string' && block.blockName ? ` \"${block.blockName}\"` : ''\n  const preview = firstText(block)\n  return `${index}: ${String(block.blockType)}${name}${preview ? ` – ${cut(preview, maxBlockPreview)}` : ''}`\n}\n\n/** The first readable words in a block, skipping ids and other short codes. */\nfunction firstText(value: unknown): string | undefined {\n  if (typeof value === 'string') {\n    const text = value.replace(/\\s+/g, ' ').trim()\n    return text.includes(' ') ? text : undefined\n  }\n  const items = Array.isArray(value)\n    ? value\n    : isRecord(value)\n      ? Object.entries(value)\n          .filter(([key]) => key !== 'id' && key !== 'blockType')\n          .map(([, item]) => item)\n      : []\n  for (const item of items) {\n    const found = firstText(item)\n    if (found) {\n      return found\n    }\n  }\n  return undefined\n}\n\n/** Reads `content.content.3.title` from a document, through objects and lists. */\nexport function valueAtReadablePath(source: unknown, path: string): unknown {\n  let current = source\n  for (const key of path.split('.').filter(Boolean)) {\n    if (Array.isArray(current) && /^\\d+$/.test(key)) {\n      current = current[Number(key)]\n    } else if (isRecord(current)) {\n      current = current[key]\n    } else {\n      return undefined\n    }\n  }\n  return current\n}\n\nfunction cut(value: string, limit: number): string {\n  return value.length > limit ? `${value.slice(0, limit)}…` : value\n}\n\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n  return Boolean(value) && typeof value === 'object' && !Array.isArray(value)\n}\n"],"names":["maxText","maxBlockPreview","maxListItems","maxDepth","outline","value","depth","cut","Array","isArray","items","slice","map","item","index","isRecord","blockType","blockLine","hidden","length","Object","fromEntries","entries","key","block","name","blockName","preview","firstText","String","text","replace","trim","includes","undefined","filter","found","valueAtReadablePath","source","path","current","split","Boolean","test","Number","limit"],"mappings":"AAAA,MAAMA,UAAU;AAChB,MAAMC,kBAAkB;AACxB,MAAMC,eAAe;AACrB,MAAMC,WAAW;AAEjB;;;CAGC,GACD,OAAO,SAASC,QAAQC,KAAc,EAAEC,QAAQ,CAAC;IAC/C,IAAI,OAAOD,UAAU,UAAU;QAC7B,OAAOE,IAAIF,OAAOL;IACpB;IACA,IAAIM,QAAQH,UAAU;QACpB,OAAO;IACT;IACA,IAAIK,MAAMC,OAAO,CAACJ,QAAQ;QACxB,MAAMK,QAAQL,MACXM,KAAK,CAAC,GAAGT,cACTU,GAAG,CAAC,CAACC,MAAMC,QACVC,SAASF,SAAS,OAAOA,KAAKG,SAAS,KAAK,WACxCC,UAAUJ,MAAMC,SAChBV,QAAQS,MAAMP,QAAQ;QAE9B,MAAMY,SAASb,MAAMc,MAAM,GAAGT,MAAMS,MAAM;QAC1C,OAAOD,SAAS,IAAI;eAAIR;YAAO,CAAC,CAAC,EAAEQ,OAAO,MAAM,CAAC;SAAC,GAAGR;IACvD;IACA,IAAI,CAACK,SAASV,QAAQ;QACpB,OAAOA;IACT;IACA,OAAOe,OAAOC,WAAW,CACvBD,OAAOE,OAAO,CAACjB,OAAOO,GAAG,CAAC,CAAC,CAACW,KAAKV,KAAK,GAAK;YAACU;YAAKnB,QAAQS,MAAMP,QAAQ;SAAG;AAE9E;AAEA,8DAA8D,GAC9D,SAASW,UAAUO,KAA8B,EAAEV,KAAa;IAC9D,MAAMW,OAAO,OAAOD,MAAME,SAAS,KAAK,YAAYF,MAAME,SAAS,GAAG,CAAC,EAAE,EAAEF,MAAME,SAAS,CAAC,CAAC,CAAC,GAAG;IAChG,MAAMC,UAAUC,UAAUJ;IAC1B,OAAO,GAAGV,MAAM,EAAE,EAAEe,OAAOL,MAAMR,SAAS,IAAIS,OAAOE,UAAU,CAAC,GAAG,EAAEpB,IAAIoB,SAAS1B,kBAAkB,GAAG,IAAI;AAC7G;AAEA,6EAA6E,GAC7E,SAAS2B,UAAUvB,KAAc;IAC/B,IAAI,OAAOA,UAAU,UAAU;QAC7B,MAAMyB,OAAOzB,MAAM0B,OAAO,CAAC,QAAQ,KAAKC,IAAI;QAC5C,OAAOF,KAAKG,QAAQ,CAAC,OAAOH,OAAOI;IACrC;IACA,MAAMxB,QAAQF,MAAMC,OAAO,CAACJ,SACxBA,QACAU,SAASV,SACPe,OAAOE,OAAO,CAACjB,OACZ8B,MAAM,CAAC,CAAC,CAACZ,IAAI,GAAKA,QAAQ,QAAQA,QAAQ,aAC1CX,GAAG,CAAC,CAAC,GAAGC,KAAK,GAAKA,QACrB,EAAE;IACR,KAAK,MAAMA,QAAQH,MAAO;QACxB,MAAM0B,QAAQR,UAAUf;QACxB,IAAIuB,OAAO;YACT,OAAOA;QACT;IACF;IACA,OAAOF;AACT;AAEA,gFAAgF,GAChF,OAAO,SAASG,oBAAoBC,MAAe,EAAEC,IAAY;IAC/D,IAAIC,UAAUF;IACd,KAAK,MAAMf,OAAOgB,KAAKE,KAAK,CAAC,KAAKN,MAAM,CAACO,SAAU;QACjD,IAAIlC,MAAMC,OAAO,CAAC+B,YAAY,QAAQG,IAAI,CAACpB,MAAM;YAC/CiB,UAAUA,OAAO,CAACI,OAAOrB,KAAK;QAChC,OAAO,IAAIR,SAASyB,UAAU;YAC5BA,UAAUA,OAAO,CAACjB,IAAI;QACxB,OAAO;YACL,OAAOW;QACT;IACF;IACA,OAAOM;AACT;AAEA,SAASjC,IAAIF,KAAa,EAAEwC,KAAa;IACvC,OAAOxC,MAAMc,MAAM,GAAG0B,QAAQ,GAAGxC,MAAMM,KAAK,CAAC,GAAGkC,OAAO,CAAC,CAAC,GAAGxC;AAC9D;AAEA,SAASU,SAASV,KAAc;IAC9B,OAAOqC,QAAQrC,UAAU,OAAOA,UAAU,YAAY,CAACG,MAAMC,OAAO,CAACJ;AACvE"}

package/dist/read/readTarget.d.ts

@@ -0,0 +1,4 @@
+import type { SanitizedConfig } from 'payload';
+import type { PlanTargetKind } from '../types.js';
+/** Reads a collection document or global with its rich text as markdown. */
+export declare function readableTarget(config: SanitizedConfig, kind: PlanTargetKind, slug: string, data: unknown): Promise<unknown>;

package/dist/read/readTarget.js

@@ -0,0 +1,13 @@
+import { lexicalToMarkdown } from '../lexical/lexicalToMarkdown.js';
+import { collectionFields, globalFields } from '../plan/catalogue.js';
+import { readableDocument } from './readable.js';
+/** Reads a collection document or global with its rich text as markdown. */ export function readableTarget(config, kind, slug, data) {
+    const fields = (kind === 'collection' ? collectionFields(config, slug) : globalFields(config, slug)) ?? [];
+    return readableDocument(fields, data, (field, value)=>lexicalToMarkdown({
+            config,
+            field,
+            data: value
+        }));
+}
+
+//# sourceMappingURL=readTarget.js.map

package/dist/read/readTarget.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/read/readTarget.ts"],"sourcesContent":["import type { SanitizedConfig } from 'payload'\n\nimport type { PlanTargetKind } from '../types.js'\n\nimport { lexicalToMarkdown } from '../lexical/lexicalToMarkdown.js'\nimport { collectionFields, globalFields } from '../plan/catalogue.js'\nimport { readableDocument } from './readable.js'\n\n/** Reads a collection document or global with its rich text as markdown. */\nexport function readableTarget(\n  config: SanitizedConfig,\n  kind: PlanTargetKind,\n  slug: string,\n  data: unknown,\n): Promise<unknown> {\n  const fields =\n    (kind === 'collection' ? collectionFields(config, slug) : globalFields(config, slug)) ?? []\n  return readableDocument(fields, data, (field, value) =>\n    lexicalToMarkdown({\n      config,\n      field,\n      data: value as unknown as Parameters<typeof lexicalToMarkdown>[0]['data'],\n    }),\n  )\n}\n"],"names":["lexicalToMarkdown","collectionFields","globalFields","readableDocument","readableTarget","config","kind","slug","data","fields","field","value"],"mappings":"AAIA,SAASA,iBAAiB,QAAQ,kCAAiC;AACnE,SAASC,gBAAgB,EAAEC,YAAY,QAAQ,uBAAsB;AACrE,SAASC,gBAAgB,QAAQ,gBAAe;AAEhD,0EAA0E,GAC1E,OAAO,SAASC,eACdC,MAAuB,EACvBC,IAAoB,EACpBC,IAAY,EACZC,IAAa;IAEb,MAAMC,SACJ,AAACH,CAAAA,SAAS,eAAeL,iBAAiBI,QAAQE,QAAQL,aAAaG,QAAQE,KAAI,KAAM,EAAE;IAC7F,OAAOJ,iBAAiBM,QAAQD,MAAM,CAACE,OAAOC,QAC5CX,kBAAkB;YAChBK;YACAK;YACAF,MAAMG;QACR;AAEJ"}

package/dist/read/readable.d.ts

@@ -0,0 +1,8 @@
+import type { Field, RichTextField } from 'payload';
+/** Turns one rich text value into markdown. Injected so the walk can be tested without a Payload config. */
+export type RichTextReader = (field: RichTextField, value: Record<string, unknown>) => Promise<string>;
+/**
+ * A document as the assistant reads it. Rich text becomes markdown, timestamps and image sizes are dropped,
+ * and long lists and strings are cut so one read cannot fill the model's context.
+ */
+export declare function readableDocument(fields: Field[], data: unknown, readRichText: RichTextReader): Promise<unknown>;