@payloadcms/plugin-mcp 4.0.0-internal.688c4d0 → 4.0.0-internal.bc5cf8c

package/dist/translations/types.d.ts

@@ -1,32 +0,0 @@
-import type { Language } from '@payloadcms/translations';
-import type { enTranslations } from './languages/en.js';
-export type PluginLanguage = Language<{
-    'plugin-mcp': {
-        apiKeyDescription: string;
-        apiKeys: string;
-        authentication: string;
-        description: string;
-        descriptionDescription: string;
-        dismiss: string;
-        keepKeyPrivate: string;
-        keyPrivateDescription: string;
-        lastUsed: string;
-        manageAPIKeys: string;
-        mcp: string;
-        noAPIKeys: string;
-        operations: string;
-        overrideAccess: string;
-        overrideAccessDescription: string;
-        permissions: string;
-        permissionsDescription: string;
-        prompts: string;
-        resources: string;
-        server: string;
-        title: string;
-        titleDescription: string;
-        tools: string;
-        userDescription: string;
-    };
-}>;
-export type PluginDefaultTranslationsObject = typeof enTranslations;
-//# sourceMappingURL=types.d.ts.map

package/dist/translations/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/translations/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AAExD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC;IACpC,YAAY,EAAE;QACZ,iBAAiB,EAAE,MAAM,CAAA;QACzB,OAAO,EAAE,MAAM,CAAA;QACf,cAAc,EAAE,MAAM,CAAA;QACtB,WAAW,EAAE,MAAM,CAAA;QACnB,sBAAsB,EAAE,MAAM,CAAA;QAC9B,OAAO,EAAE,MAAM,CAAA;QACf,cAAc,EAAE,MAAM,CAAA;QACtB,qBAAqB,EAAE,MAAM,CAAA;QAC7B,QAAQ,EAAE,MAAM,CAAA;QAChB,aAAa,EAAE,MAAM,CAAA;QACrB,GAAG,EAAE,MAAM,CAAA;QACX,SAAS,EAAE,MAAM,CAAA;QACjB,UAAU,EAAE,MAAM,CAAA;QAClB,cAAc,EAAE,MAAM,CAAA;QACtB,yBAAyB,EAAE,MAAM,CAAA;QACjC,WAAW,EAAE,MAAM,CAAA;QACnB,sBAAsB,EAAE,MAAM,CAAA;QAC9B,OAAO,EAAE,MAAM,CAAA;QACf,SAAS,EAAE,MAAM,CAAA;QACjB,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,EAAE,MAAM,CAAA;QACb,gBAAgB,EAAE,MAAM,CAAA;QACxB,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,CAAA;KACxB,CAAA;CACF,CAAC,CAAA;AAEF,MAAM,MAAM,+BAA+B,GAAG,OAAO,cAAc,CAAA"}

package/dist/translations/types.js

@@ -1,3 +0,0 @@
-export { };
-
-//# sourceMappingURL=types.js.map

package/dist/translations/types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/translations/types.ts"],"sourcesContent":["import type { Language } from '@payloadcms/translations'\n\nimport type { enTranslations } from './languages/en.js'\n\nexport type PluginLanguage = Language<{\n  'plugin-mcp': {\n    apiKeyDescription: string\n    apiKeys: string\n    authentication: string\n    description: string\n    descriptionDescription: string\n    dismiss: string\n    keepKeyPrivate: string\n    keyPrivateDescription: string\n    lastUsed: string\n    manageAPIKeys: string\n    mcp: string\n    noAPIKeys: string\n    operations: string\n    overrideAccess: string\n    overrideAccessDescription: string\n    permissions: string\n    permissionsDescription: string\n    prompts: string\n    resources: string\n    server: string\n    title: string\n    titleDescription: string\n    tools: string\n    userDescription: string\n  }\n}>\n\nexport type PluginDefaultTranslationsObject = typeof enTranslations\n"],"names":[],"mappings":"AAiCA,WAAmE"}

package/src/collection/getAccessField.ts

@@ -1,84 +0,0 @@
-import type { JSONField } from 'payload'
-
-import type { ClientMCPPluginConfig, MCPItem, SanitizedMCPPluginConfig } from '../types.js'
-
-import {
-  COLLECTION_AUTH_BUILTINS,
-  COLLECTION_BUILTINS,
-  GLOBAL_BUILTINS,
-} from '../mcp/builtinTools.js'
-
-/**
- * Returns the API key collection's `access` field — a JSON field whose value
- * is the `MCPAPIKeysDocAccessTree` the endpoint consults. The actual UI is
- * a custom client component (`AccessField`) which renders a permissions
- * matrix; the field's stored shape is just the runtime access tree.
- */
-export const getAccessField = ({
-  pluginConfig,
-}: {
-  pluginConfig: SanitizedMCPPluginConfig
-}): JSONField => {
-  const clientPluginConfig = sanitizeClientPluginConfig(pluginConfig)
-
-  return {
-    name: 'access',
-    type: 'json',
-    admin: {
-      components: {
-        Field: {
-          clientProps: { pluginConfig: clientPluginConfig },
-          path: '@payloadcms/plugin-mcp/client#AccessField',
-        },
-      },
-    },
-    defaultValue: {},
-    label: false,
-  }
-}
-
-/**
- * Strips the non-serializable parts of `SanitizedMCPPluginConfig` (handlers,
- * input/argsSchema functions, etc.) so the result is safe to thread to a
- * client component via `clientProps`.
- */
-const sanitizeClientPluginConfig = (
-  pluginConfig: SanitizedMCPPluginConfig,
-): ClientMCPPluginConfig => ({
-  items: pluginConfig.items.map((item) => {
-    const group = itemGroup(item)
-
-    return {
-      ...(item.type === 'collectionTool' ? { collectionSlug: item.collectionSlug } : {}),
-      ...(item.type === 'globalTool' ? { globalSlug: item.globalSlug } : {}),
-      type: item.type,
-      configKey: item.configKey,
-      ...(group === 'operations' ? {} : { description: itemDescription(item) }),
-      group,
-      label: item.label,
-    }
-  }),
-})
-
-const itemDescription = (item: MCPItem): string => {
-  if (item.type === 'prompt') {
-    return item.prompt.description
-  }
-  if (item.type === 'resource') {
-    return item.resource.description
-  }
-  return item.tool.description
-}
-
-const itemGroup = (item: MCPItem): 'auth' | 'custom' | 'operations' | undefined => {
-  if (item.type === 'collectionTool') {
-    if (item.configKey in COLLECTION_BUILTINS) {
-      return 'operations'
-    }
-    return item.configKey in COLLECTION_AUTH_BUILTINS ? 'auth' : 'custom'
-  }
-  if (item.type === 'globalTool') {
-    return item.configKey in GLOBAL_BUILTINS ? 'operations' : 'custom'
-  }
-  return undefined
-}

package/src/collection/index.ts

@@ -1,105 +0,0 @@
-import type { CollectionConfig } from 'payload'
-
-import { createAPIKeyFields } from 'payload'
-
-import type { SanitizedMCPPluginConfig } from '../types.js'
-
-import { getAccessField } from './getAccessField.js'
-
-const apiKeyStorageFields = createAPIKeyFields({
-  apiKeyField: {
-    admin: {
-      components: { Field: '@payloadcms/plugin-mcp/client#APIKeyField' },
-    },
-    required: true,
-  },
-  apiKeyIndexField: {
-    index: true,
-    required: true,
-  },
-  includeEnableAPIKey: false,
-})
-
-export const getAPIKeysCollection = ({
-  pluginConfig,
-}: {
-  pluginConfig: SanitizedMCPPluginConfig
-}): CollectionConfig => {
-  const collection: CollectionConfig = {
-    slug: 'payload-mcp-api-keys',
-    admin: {
-      components: {
-        views: {
-          list: {
-            NoResults: '@payloadcms/plugin-mcp/client#APIKeysEmptyState',
-          },
-        },
-      },
-      defaultColumns: ['label', 'lastUsed', 'user'],
-      // Kept out of the main nav — reachable through the user menu's settings instead.
-      group: false,
-      useAsTitle: 'label',
-    },
-    fields: [
-      ...apiKeyStorageFields,
-      getAccessField({ pluginConfig }),
-      {
-        name: 'label',
-        type: 'text',
-        admin: {
-          description: ({ t }) => t('plugin-mcp:titleDescription'),
-          position: 'sidebar',
-        },
-        label: ({ t }) => t('plugin-mcp:title'),
-      },
-      {
-        name: 'description',
-        type: 'text',
-        admin: {
-          description: ({ t }) => t('plugin-mcp:descriptionDescription'),
-          position: 'sidebar',
-        },
-        label: ({ t }) => t('plugin-mcp:description'),
-      },
-      {
-        name: 'lastUsed',
-        type: 'date',
-        admin: {
-          date: { pickerAppearance: 'dayAndTime' },
-          disabled: { field: true },
-        },
-        label: ({ t }) => t('plugin-mcp:lastUsed'),
-      },
-      {
-        name: 'user',
-        type: 'relationship',
-        admin: {
-          description: ({ t }) => t('plugin-mcp:userDescription'),
-          position: 'sidebar',
-        },
-        label: ({ t }) => t('general:user'),
-        relationTo: pluginConfig.userCollection,
-        required: true,
-      },
-      {
-        name: 'overrideAccess',
-        type: 'checkbox',
-        admin: {
-          description: ({ t }) => t('plugin-mcp:overrideAccessDescription'),
-          position: 'sidebar',
-        },
-        defaultValue: false,
-        label: ({ t }) => t('plugin-mcp:overrideAccess'),
-      },
-    ],
-    labels: {
-      plural: ({ t }) => `${t('plugin-mcp:mcp')} ${t('plugin-mcp:apiKeys')}`,
-      singular: ({ t }) => `${t('plugin-mcp:mcp')} ${t('authentication:apiKey')}`,
-    },
-    versions: false,
-  }
-
-  return pluginConfig.overrideApiKeyCollection
-    ? pluginConfig.overrideApiKeyCollection(collection)
-    : collection
-}

package/src/components/APIKeyField/index.client.tsx

@@ -1,73 +0,0 @@
-'use client'
-
-import { APIKeyInput, Button, useField, useTranslation, WarningTriangleIcon } from '@payloadcms/ui'
-import React, { useState } from 'react'
-
-import type {
-  PluginMCPTranslationKeys,
-  PluginMCPTranslations,
-} from '../../translations/index.js'
-
-import './index.css'
-
-const baseClass = 'mcp-api-key-field'
-
-/**
- * Custom component for the MCP API-keys collection's `apiKey` field:
- * - no key yet: a "Generate new key" button
- * - key set: a dismissible privacy warning + the shared masked-key input
- */
-export const APIKeyField: React.FC = () => {
-  const { setValue: setApiKey, value: apiKey } = useField<string>({ path: 'apiKey' })
-  const { t } = useTranslation<PluginMCPTranslations, PluginMCPTranslationKeys>()
-  const [isWarningDismissed, setIsWarningDismissed] = useState(false)
-
-  const generateKey = () => {
-    setApiKey(crypto.randomUUID())
-    setIsWarningDismissed(false)
-  }
-
-  return (
-    <div className={baseClass}>
-      <p className={`${baseClass}__description`}>
-        {t('plugin-mcp:apiKeyDescription')}
-      </p>
-      <div className={`${baseClass}__panel`}>
-        <div className={`${baseClass}__header`}>
-          <span className={`${baseClass}__title`}>{t('authentication:apiKey')}</span>
-          {!apiKey && (
-            <Button
-              buttonStyle="primary"
-              className={`${baseClass}__generate`}
-              onClick={generateKey}
-            >
-              {t('authentication:generateNewAPIKey')}
-            </Button>
-          )}
-        </div>
-        {Boolean(apiKey) && (
-          <div className={`${baseClass}__body`}>
-            {!isWarningDismissed && (
-              <div className={`${baseClass}__warning`}>
-                <WarningTriangleIcon className={`${baseClass}__warning-icon`} />
-                <p className={`${baseClass}__warning-text`}>
-                  <strong>{t('plugin-mcp:keepKeyPrivate')}</strong>
-                  {` ${t('plugin-mcp:keyPrivateDescription')}`}
-                </p>
-                <button
-                  aria-label={t('plugin-mcp:dismiss')}
-                  className={`${baseClass}__warning-dismiss`}
-                  onClick={() => setIsWarningDismissed(true)}
-                  type="button"
-                >
-                  &times;
-                </button>
-              </div>
-            )}
-            <APIKeyInput aria-label={t('authentication:apiKey')} value={apiKey} />
-          </div>
-        )}
-      </div>
-    </div>
-  )
-}

package/src/components/APIKeyField/index.css

@@ -1,105 +0,0 @@
-@layer payload-default {
-  /* Section wrapper: description + panel, closed off by a full-bleed divider
-     that spans the fields column past its horizontal gutter. */
-  .mcp-api-key-field {
-    display: flex;
-    flex-direction: column;
-    gap: var(--base);
-    margin-inline: calc(-1 * var(--gutter-h));
-    padding-inline: var(--gutter-h);
-    padding-block-end: var(--spacer-4);
-    border-block-end: var(--stroke-width-small) solid var(--color-border);
-  }
-
-  .mcp-api-key-field__description {
-    margin: 0;
-    color: var(--color-text);
-    font-family: var(--text-body-medium-font-family);
-    font-size: var(--text-body-medium-font-size);
-    font-weight: var(--text-body-medium-font-weight);
-    line-height: var(--text-body-medium-line-height);
-    letter-spacing: var(--text-body-medium-letter-spacing);
-  }
-
-  .mcp-api-key-field__panel {
-    overflow: hidden;
-    background: var(--color-bg);
-    border: var(--stroke-width-small) solid var(--color-border);
-    border-radius: var(--button-radius);
-  }
-
-  .mcp-api-key-field__header {
-    display: flex;
-    align-items: center;
-    justify-content: space-between;
-    gap: var(--spacer-2);
-    min-height: var(--spacer-5);
-    padding: var(--spacer-2) var(--spacer-3);
-    background: var(--color-bg-secondary);
-  }
-
-  /* Holds the warning + key row; its top border is the full-width divider
-     under the header. Only rendered once a key exists. */
-  .mcp-api-key-field__body {
-    display: flex;
-    flex-direction: column;
-    gap: var(--spacer-2);
-    padding: var(--spacer-3);
-    border-block-start: var(--stroke-width-small) solid var(--color-border);
-  }
-
-  .mcp-api-key-field__title {
-    color: var(--color-text);
-    font-family: var(--text-body-medium-strong-font-family);
-    font-size: var(--text-body-medium-strong-font-size);
-    font-weight: var(--text-body-medium-strong-font-weight);
-    line-height: var(--text-body-medium-strong-line-height);
-  }
-
-  .mcp-api-key-field__generate {
-    margin: 0;
-  }
-
-  /* Matches the core Banner's warning treatment: theme-adaptive warning-tertiary
-     bg with regular --color-text (NOT --color-text-onwarning, which is only
-     defined for light mode and reads as muddy dark-on-dark in dark mode). */
-  .mcp-api-key-field__warning {
-    display: flex;
-    align-items: center;
-    gap: calc(var(--base) / 2);
-    padding: calc(var(--spacer-2) + (var(--spacer-1) / 2)) calc(var(--base) / 2);
-    background: var(--color-bg-warning-tertiary);
-    border: none;
-    border-radius: var(--radius-medium);
-    color: var(--color-text);
-  }
-
-  .mcp-api-key-field__warning-icon {
-    flex-shrink: 0;
-    width: 15px;
-    height: 13px;
-  }
-
-  .mcp-api-key-field__warning-text {
-    flex-grow: 1;
-    margin: 0;
-    font-family: var(--text-body-medium-font-family);
-    font-size: var(--text-body-medium-font-size);
-    line-height: var(--text-body-medium-line-height);
-  }
-
-  .mcp-api-key-field__warning-text strong {
-    font-weight: var(--text-body-medium-strong-font-weight);
-  }
-
-  .mcp-api-key-field__warning-dismiss {
-    appearance: none;
-    background: none;
-    border: none;
-    cursor: pointer;
-    color: inherit;
-    font-size: 1rem;
-    line-height: 1;
-    padding: 0;
-  }
-}

package/src/components/APIKeysEmptyState/index.client.tsx

@@ -1,36 +0,0 @@
-'use client'
-
-import type { NoResultsClientProps } from 'payload'
-
-import { Button, NoListResults, useTranslation } from '@payloadcms/ui'
-import React from 'react'
-
-import type {
-  PluginMCPTranslationKeys,
-  PluginMCPTranslations,
-} from '../../translations/index.js'
-
-export const APIKeysEmptyState: React.FC<NoResultsClientProps> = ({
-  hasCreatePermission,
-  newDocumentURL,
-  viewType,
-}) => {
-  const { t } = useTranslation<PluginMCPTranslations, PluginMCPTranslationKeys>()
-
-  return (
-    <NoListResults
-      Actions={
-        hasCreatePermission && newDocumentURL && viewType !== 'trash'
-          ? [
-              <Button el="link" key="create" to={newDocumentURL}>
-                {t('authentication:generateNewAPIKey')}
-              </Button>,
-            ]
-          : []
-      }
-      description={t('plugin-mcp:apiKeyDescription')}
-      title={t('plugin-mcp:noAPIKeys')}
-      withMargin
-    />
-  )
-}