payload-intl 1.1.3 → 1.2.1

package/README.md

@@ -1,267 +1,108 @@
 # payload-intl
 
-**payload-intl** moves translations out of your codebase.
+Schema-driven internationalization for Payload CMS using ICU MessageFormat.
 
-1. Define message keys (and their arguments) in TypeScript.
-2. Translate them in Payload’s admin panel — no code required.
+[![npm version](https://img.shields.io/npm/v/payload-intl)](https://www.npmjs.com/package/payload-intl)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
-**Features**
-
-- Define message schema in code; edit translations in a rich admin UI
-- Compatible with [next-intl](https://next-intl.dev/) and any ICU consumer
-- Automatic runtime validation of message arguments
-- Autocomplete to quickly insert and configure valid ICU arguments
-- Add optional descriptions to each message so editors understand the context
-- Visual tree & tabbed editor for quick navigation
-<!-- - Support for Rich Text messages -->
-<!-- - Import/export JSON, copy messages between paths -->
-
-## Getting Started
-
-```bash
-# pnpm
-pnpm add payload-intl
-# yarn
-yarn add payload-intl
-# npm
-npm install payload-intl
-```
-
-### 1) Define messages
-
-Organize messages in a hierarchical structure using ICU MessageFormat:
-
-```typescript
-// messages.ts
-export default {
-  UserProfile: {
-    title: "Hello {firstName}",
-    description:
-      "Welcome back, {firstName}! You have {count, plural, =0 {no messages} one {# message} other {# messages}}.",
-    status:
-      "Your account is {status, select, active {active} inactive {inactive} pending {pending} other {unknown}}.",
-  },
-  Navigation: {
-    home: "Home",
-    about: "About",
-  },
-} as const;
-```
-
-You can also use JSON files, but additional steps are required for type-safe arguments with next-intl. See the [next-intl documentation](https://next-intl.dev/docs/workflows/typescript#messages-arguments) for details.
-
-### 2) Configure Payload
-
-Add the plugin to your `payload.config.ts`:
-
-```typescript
-import { buildConfig } from "payload";
-import { intlPlugin } from "payload-intl";
+## Overview
 
-import messages from "./messages";
+Define your message keys as a typed schema using ICU MessageFormat syntax, then manage translations across locales in a rich admin UI with validation, autocompletion, and support for plurals, selects, dates, and tags. Messages can be fetched server-side or client-side.
 
-export default buildConfig({
-  // the plugin reads locales from this config
-  localization: {
-    locales: ["en", "de", "fr"],
-    defaultLocale: "en",
-  },
-  plugins: [
-    // add the plugin
-    intlPlugin({
-      schema: messages,
-    }),
-    // add the "messages" collection to your storage adapter
-  ],
-});
-```
-
-### 3) Fetch messages in your app
-
-**Node.js:**
-
-```typescript
-import config from "@payload-config";
-import { getPayload } from "payload";
-import { fetchMessages } from "payload-intl/requests";
+**Features**
 
-const payload = await getPayload({ config });
-const messages = await fetchMessages(payload, "en");
-```
+- **ICU MessageFormat** — variables, plurals, selects, number/date/time formatting, and XML-like tags.
+- **Schema-driven** — define message keys and templates in a typed schema with automatic validation.
+- **Rich editor UI** — message editor with variable chips, autocompletion, and inline ICU element editors.
+- **JSON import** — bulk-import translations from JSON files directly in the admin UI.
+- **Flexible fetching** — works with a Payload instance (server-side) or a config object (client-side API fetch).
 
-**Edge runtime:**
+## Installation
 
-```typescript
-const response = await fetch(`${process.env.PAYLOAD_API_URL}/intl-plugin/en`);
-const messages = await response.json();
+```sh
+pnpm add payload-intl
 ```
 
-## Plugin Options
-
-The `intlPlugin` accepts the following configuration:
+## Usage
 
-| Option                  | Default                  | Description                                             |
-| ----------------------- | ------------------------ | ------------------------------------------------------- |
-| `schema`                | **Required**             | Your messages schema definition                         |
-| `collectionSlug`        | `"messages"`             | Custom collection slug                                  |
-| `editorAccess`          | Authenticated users only | Access control for editing messages                     |
-| `hooks`                 | -                        | Collection hooks with and additional `afterUpdate` hook |
-| `tabs`                  | -                        | Enable tabbed interface                                 |
-
-<!-- ## Storage Adapter Requirements
-
-The plugin creates a "messages" upload collection that stores translations as JSON files.
-
-You must ensure that the storage provider returns the direct URL to the uploaded files and read access is guaranteed. -->
-
-<!-- ## Message Schema Definition
-
-### Message Descriptions
-
-Add context for editors using the syntax `"[Description] message"`:
-
-```typescript
-export default {
-  UserProfile: {
-    title: "[Greeting shown at the top of user profile page] Hello {firstName}",
-    description:
-      "[Subtitle with user's name and message count] Welcome back, {firstName}! You have {count} new messages.",
-  },
-} as const;
-``` -->
-
-<!-- ### Rich Text Messages
-
-Use `"$RICH$"` as the message value to enable rich text editing. Note that rich text messages do not support ICU arguments.
-
-```typescript
-export default {
-  Content: {
-    welcome: "$RICH$", // Rich text editor will be used
-    terms: "$RICH$", // Rich text editor will be used
-  },
-} as const;
-``` -->
-
-## Example Usage
-
-Here's a complete example showing how to integrate payload-intl using next-intl and S3 storage:
-
-```typescript
+```ts
 // payload.config.ts
-import { s3Storage } from "@payloadcms/storage-s3";
-import { revalidateTag } from "next/cache";
-import { buildConfig } from "payload";
-import { intlPlugin } from "payload-intl";
-
-import { messages } from "./i18n/messages";
+import { buildConfig } from 'payload';
+import { intlPlugin } from 'payload-intl';
 
 export default buildConfig({
   localization: {
-    locales: ["en", "de", "fr"],
-    defaultLocale: "en",
+    locales: ['en', 'de', 'fr'],
+    defaultLocale: 'en',
   },
+  // ...
   plugins: [
     intlPlugin({
-      schema: messages,
-      hooks: {
-        afterUpdate: () => revalidateTag("messages"), // or anything else you want
-      },
-    }),
-    s3Storage({
-      collections: {
-        messages: {
-          prefix: "messages", // or anything else you want
+      schema: {
+        common: {
+          greeting: '[Main greeting] Hello {name}!',
+          items: '{count, plural, one {# item} other {# items}}',
+        },
+        auth: {
+          login: 'Sign in',
+          logout: 'Sign out',
         },
       },
+      tabs: true,
     }),
   ],
 });
 ```
 
-```typescript
-// i18n/messages.ts
-export const messages = {
-  UserProfile: {
-    title: "Hello {firstName}",
-    description:
-      "Welcome back, {firstName}! You have {count, plural, =0 {no messages} one {# message} other {# messages}}.",
-  },
-  // ...
-} as const;
-```
+Fetch messages in your application:
+
+```ts
+import { fetchMessages } from 'payload-intl';
 
-```typescript
-// i18n/global.ts
-import type messages from "./messages";
+// Server-side — pass the Payload instance directly
+const messages = await fetchMessages(payload, 'en');
 
-declare module "next-intl" {
-  interface AppConfig {
-    Messages: typeof messages;
-    // ...
-  }
-}
+// Client-side — pass a config object to fetch from the REST API
+const messages = await fetchMessages({ serverUrl: 'http://localhost:3000' }, 'en');
 ```
 
-```typescript
-// i18n/request.ts
-import { getRequestConfig } from "next-intl/server";
+### Options
 
-import { fetchCachedMessages } from "./server/messages";
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `schema` | `MessagesSchema` | — | Required. Nested object defining message keys and ICU templates. Leaf values are ICU MessageFormat strings, optionally prefixed with a `[description]`. |
+| `collectionSlug` | `CollectionSlug` | `'messages'` | Slug of the collection used to store translation files. |
+| `editorAccess` | `(req: PayloadRequest) => boolean \| Promise<boolean>` | `(req) => req.user !== null` | Access control function that determines who can edit messages. |
+| `hooks` | `MessagesHooks` | `{}` | Collection hooks. Extends Payload's collection hooks with an additional `afterUpdate` callback fired when translations are saved. |
+| `tabs` | `boolean` | `false` | When enabled, top-level keys in the schema are rendered as tabs in the admin UI. |
 
-export default getRequestConfig(async ({ locale }) => {
-  const messages = await fetchCachedMessages(locale);
+## Contributing
 
-  return {
-    locale,
-    messages,
-  };
-});
-```
+This plugin lives in the [payload-plugins](https://github.com/davincicoding-org/payload-plugins) monorepo.
 
-```typescript
-// server.ts
-"use server";
+### Development
 
-import config from "@payload-config";
-import { unstable_cache } from "next/cache";
-import { getPayload } from "payload";
-import { fetchMessages } from "payload-intl";
+```sh
+pnpm install
 
-export const fetchCachedMessages = unstable_cache(
-  async (locale: string) => {
-    // Node.js
-    const payload = await getPayload({ config });
-    return await fetchMessages(payload, locale);
+# watch this plugin for changes
+pnpm --filter payload-intl dev
 
-    // Edge runtime
-    const response = await fetch(
-      `${process.env.PAYLOAD_API_URL}/intl-plugin/en`,
-    );
-    return await response.json();
-  },
-  ["messages"],
-  {
-    revalidate: false,
-  },
-);
+# run the Payload dev app (in a second terminal)
+pnpm --filter sandbox dev
 ```
 
-## Development
+The `sandbox/` directory is a Next.js + Payload app that imports plugins via `workspace:*` — use it to test changes locally.
 
-```bash
-# Install dependencies
-pnpm install
+### Code quality
 
-# Start development server
-pnpm dev
+- **Formatting & linting** — handled by [Biome](https://biomejs.dev/), enforced on commit via husky + lint-staged.
+- **Commits** — must follow [Conventional Commits](https://www.conventionalcommits.org/) with a valid scope (e.g. `fix(payload-intl): ...`).
+- **Changesets** — please include a [changeset](https://github.com/changesets/changesets) in your PR by running `pnpm release`.
 
-# Build the plugin
-pnpm build
+### Issues & PRs
 
-# Run tests
-pnpm test
-```
+Bug reports and feature requests are welcome — [open an issue](https://github.com/davincicoding-org/payload-plugins/issues).
 
 ## License
 

package/dist/_common/index.d.ts

@@ -0,0 +1,17 @@
+import type { CollectionConfig, CollectionSlug, TypeWithID } from 'payload';
+import z from 'zod';
+export declare const entityIdSchema: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+export type EntityID = TypeWithID['id'] & z.infer<typeof entityIdSchema>;
+export declare const isPopulated: <T extends TypeWithID>(relationship: T | EntityID) => relationship is T;
+export declare function assertPopulated<T extends TypeWithID | null>(docsOrIds: (T | EntityID)[], errorMessage?: (id: EntityID) => string): T[];
+export declare function assertPopulated<T extends TypeWithID | null>(docOrId: T | EntityID, errorMessage?: (id: EntityID) => string): T;
+export declare const createCollectionConfigFactory: <T extends Record<string, unknown>>(factory: Omit<CollectionConfig, "slug"> | ((options: T & {
+    slug: CollectionSlug;
+}) => Omit<CollectionConfig, "slug">)) => (options: T & {
+    slug: CollectionSlug;
+}) => CollectionConfig;
+export declare const resolveForeignKey: (entity: TypeWithID["id"] | TypeWithID) => string | number;
+export { defineProcedure, type Procedure, type ProcedureBuilder, } from './procedure';
+export { getAdminURL, getApiURL, getServerURL } from './urls';
+export { findFields, uncaughtSwitchCase } from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/_common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/_common/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC5E,OAAO,CAAC,MAAM,KAAK,CAAC;AAIpB,eAAO,MAAM,cAAc,iDAAoC,CAAC;AAChE,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAIzE,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,UAAU,gBAChC,CAAC,GAAG,QAAQ,KACzB,YAAY,IAAI,CAAqC,CAAC;AAEzD,wBAAgB,eAAe,CAAC,CAAC,SAAS,UAAU,GAAG,IAAI,EACzD,SAAS,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,EAAE,EAC3B,YAAY,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,KAAK,MAAM,GACtC,CAAC,EAAE,CAAC;AACP,wBAAgB,eAAe,CAAC,CAAC,SAAS,UAAU,GAAG,IAAI,EACzD,OAAO,EAAE,CAAC,GAAG,QAAQ,EACrB,YAAY,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,KAAK,MAAM,GACtC,CAAC,CAAC;AAeL,eAAO,MAAM,6BAA6B,GACvC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WAE5B,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,GAC9B,CAAC,CACC,OAAO,EAAE,CAAC,GAAG;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,KAClC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,eAEhC,CAAC,GAAG;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,KAAG,gBAGvC,CAAC;AAEL,eAAO,MAAM,iBAAiB,WAAY,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,oBACtB,CAAC;AAElD,OAAO,EACL,eAAe,EACf,KAAK,SAAS,EACd,KAAK,gBAAgB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC"}

package/dist/_common/index.js

@@ -0,0 +1,27 @@
+import z from 'zod';
+// MARK: Types
+export const entityIdSchema = z.union([
+    z.number(),
+    z.string()
+]);
+// MARK: Type Guards
+export const isPopulated = (relationship)=>typeof relationship === 'object';
+export function assertPopulated(value, errorMessage = (id)=>`Doc is not populated: [${id}]`) {
+    if (value === null) return value;
+    if (Array.isArray(value)) {
+        return value.map((item)=>assertPopulated(item, errorMessage));
+    }
+    if (isPopulated(value)) return value;
+    throw new Error(errorMessage(value));
+}
+// MARK: Utilities
+export const createCollectionConfigFactory = (factory)=>(options)=>({
+            slug: options.slug,
+            ...typeof factory === 'function' ? factory(options) : factory
+        });
+export const resolveForeignKey = (entity)=>typeof entity === 'object' ? entity.id : entity;
+export { defineProcedure } from './procedure';
+export { getAdminURL, getApiURL, getServerURL } from './urls';
+export { findFields, uncaughtSwitchCase } from './utils';
+
+//# sourceMappingURL=index.js.map

package/dist/_common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/_common/index.ts"],"sourcesContent":["import type { CollectionConfig, CollectionSlug, TypeWithID } from 'payload';\nimport z from 'zod';\n\n// MARK: Types\n\nexport const entityIdSchema = z.union([z.number(), z.string()]);\nexport type EntityID = TypeWithID['id'] & z.infer<typeof entityIdSchema>;\n\n// MARK: Type Guards\n\nexport const isPopulated = <T extends TypeWithID>(\n  relationship: T | EntityID,\n): relationship is T => typeof relationship === 'object';\n\nexport function assertPopulated<T extends TypeWithID | null>(\n  docsOrIds: (T | EntityID)[],\n  errorMessage?: (id: EntityID) => string,\n): T[];\nexport function assertPopulated<T extends TypeWithID | null>(\n  docOrId: T | EntityID,\n  errorMessage?: (id: EntityID) => string,\n): T;\nexport function assertPopulated<T extends TypeWithID | null>(\n  value: T | EntityID | (T | EntityID)[],\n  errorMessage = (id: EntityID) => `Doc is not populated: [${id}]`,\n): T | T[] {\n  if (value === null) return value;\n  if (Array.isArray(value)) {\n    return value.map((item) => assertPopulated(item, errorMessage));\n  }\n  if (isPopulated(value)) return value;\n  throw new Error(errorMessage(value as EntityID));\n}\n\n// MARK: Utilities\n\nexport const createCollectionConfigFactory =\n  <T extends Record<string, unknown>>(\n    factory:\n      | Omit<CollectionConfig, 'slug'>\n      | ((\n          options: T & { slug: CollectionSlug },\n        ) => Omit<CollectionConfig, 'slug'>),\n  ) =>\n  (options: T & { slug: CollectionSlug }): CollectionConfig => ({\n    slug: options.slug,\n    ...(typeof factory === 'function' ? factory(options) : factory),\n  });\n\nexport const resolveForeignKey = (entity: TypeWithID['id'] | TypeWithID) =>\n  typeof entity === 'object' ? entity.id : entity;\n\nexport {\n  defineProcedure,\n  type Procedure,\n  type ProcedureBuilder,\n} from './procedure';\nexport { getAdminURL, getApiURL, getServerURL } from './urls';\nexport { findFields, uncaughtSwitchCase } from './utils';\n"],"names":["z","entityIdSchema","union","number","string","isPopulated","relationship","assertPopulated","value","errorMessage","id","Array","isArray","map","item","Error","createCollectionConfigFactory","factory","options","slug","resolveForeignKey","entity","defineProcedure","getAdminURL","getApiURL","getServerURL","findFields","uncaughtSwitchCase"],"mappings":"AACA,OAAOA,OAAO,MAAM;AAEpB,cAAc;AAEd,OAAO,MAAMC,iBAAiBD,EAAEE,KAAK,CAAC;IAACF,EAAEG,MAAM;IAAIH,EAAEI,MAAM;CAAG,EAAE;AAGhE,oBAAoB;AAEpB,OAAO,MAAMC,cAAc,CACzBC,eACsB,OAAOA,iBAAiB,SAAS;AAUzD,OAAO,SAASC,gBACdC,KAAsC,EACtCC,eAAe,CAACC,KAAiB,CAAC,uBAAuB,EAAEA,GAAG,CAAC,CAAC;IAEhE,IAAIF,UAAU,MAAM,OAAOA;IAC3B,IAAIG,MAAMC,OAAO,CAACJ,QAAQ;QACxB,OAAOA,MAAMK,GAAG,CAAC,CAACC,OAASP,gBAAgBO,MAAML;IACnD;IACA,IAAIJ,YAAYG,QAAQ,OAAOA;IAC/B,MAAM,IAAIO,MAAMN,aAAaD;AAC/B;AAEA,kBAAkB;AAElB,OAAO,MAAMQ,gCACX,CACEC,UAMF,CAACC,UAA6D,CAAA;YAC5DC,MAAMD,QAAQC,IAAI;YAClB,GAAI,OAAOF,YAAY,aAAaA,QAAQC,WAAWD,OAAO;QAChE,CAAA,EAAG;AAEL,OAAO,MAAMG,oBAAoB,CAACC,SAChC,OAAOA,WAAW,WAAWA,OAAOX,EAAE,GAAGW,OAAO;AAElD,SACEC,eAAe,QAGV,cAAc;AACrB,SAASC,WAAW,EAAEC,SAAS,EAAEC,YAAY,QAAQ,SAAS;AAC9D,SAASC,UAAU,EAAEC,kBAAkB,QAAQ,UAAU"}

package/dist/_common/procedure.d.ts

@@ -0,0 +1,34 @@
+import type { Endpoint, PayloadRequest } from 'payload';
+type Method = 'get' | 'post' | 'put' | 'patch' | 'delete';
+/** Any Zod-like schema with safeParse and inferred output */
+interface ZodLike<TOutput = unknown> {
+    safeParse(data: unknown): {
+        success: true;
+        data: TOutput;
+    } | {
+        success: false;
+        error: unknown;
+    };
+}
+type InferOutput<T> = T extends ZodLike<infer O> ? O : never;
+interface ProcedureConfig<TSchema extends ZodLike | undefined = undefined> {
+    path: `/${string}`;
+    method: Method;
+    input?: TSchema;
+}
+export interface Procedure<TInput, TOutput> {
+    path: `/${string}`;
+    method: Method;
+    endpoint(handler: (req: PayloadRequest, ...args: TInput extends void ? [] : [input: TInput]) => Promise<unknown | Response>): Endpoint;
+    call(apiUrl: string, ...args: TInput extends void ? [] : [input: TInput]): Promise<TOutput>;
+}
+export interface ProcedureBuilder<TInput> {
+    path: string;
+    method: Method;
+    returns<TOutput>(): Procedure<TInput, TOutput>;
+    endpoint(handler: (req: PayloadRequest, ...args: TInput extends void ? [] : [input: TInput]) => Promise<unknown | Response>): Endpoint;
+    call(apiUrl: string, ...args: TInput extends void ? [] : [input: TInput]): Promise<unknown>;
+}
+export declare function defineProcedure<TSchema extends ZodLike | undefined = undefined>(config: ProcedureConfig<TSchema>): ProcedureBuilder<TSchema extends ZodLike ? InferOutput<TSchema> : void>;
+export {};
+//# sourceMappingURL=procedure.d.ts.map

package/dist/_common/procedure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"procedure.d.ts","sourceRoot":"","sources":["../../src/_common/procedure.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAExD,KAAK,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE1D,6DAA6D;AAC7D,UAAU,OAAO,CAAC,OAAO,GAAG,OAAO;IACjC,SAAS,CACP,IAAI,EAAE,OAAO,GACZ;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,GAAG;QAAE,OAAO,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;CAC1E;AAED,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE7D,UAAU,eAAe,CAAC,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS;IACvE,IAAI,EAAE,IAAI,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,SAAS,CAAC,MAAM,EAAE,OAAO;IACxC,IAAI,EAAE,IAAI,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CACN,OAAO,EAAE,CACP,GAAG,EAAE,cAAc,EACnB,GAAG,IAAI,EAAE,MAAM,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,KAChD,OAAO,CAAC,OAAO,GAAG,QAAQ,CAAC,GAC/B,QAAQ,CAAC;IACZ,IAAI,CACF,MAAM,EAAE,MAAM,EACd,GAAG,IAAI,EAAE,MAAM,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,GAClD,OAAO,CAAC,OAAO,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB,CAAC,MAAM;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/C,QAAQ,CACN,OAAO,EAAE,CACP,GAAG,EAAE,cAAc,EACnB,GAAG,IAAI,EAAE,MAAM,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,KAChD,OAAO,CAAC,OAAO,GAAG,QAAQ,CAAC,GAC/B,QAAQ,CAAC;IACZ,IAAI,CACF,MAAM,EAAE,MAAM,EACd,GAAG,IAAI,EAAE,MAAM,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,GAClD,OAAO,CAAC,OAAO,CAAC,CAAC;CACrB;AA2GD,wBAAgB,eAAe,CAC7B,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,EAE/C,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,GAC/B,gBAAgB,CAAC,OAAO,SAAS,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAazE"}

package/dist/_common/procedure.js

@@ -0,0 +1,110 @@
+function wrapOutput(output) {
+    if (output instanceof Response) return output;
+    return Response.json(output);
+}
+function createProcedure(config, inputSchema) {
+    return {
+        path: config.path,
+        method: config.method,
+        endpoint (handler) {
+            return {
+                path: config.path,
+                method: config.method,
+                handler: async (req)=>{
+                    if (inputSchema) {
+                        if (config.method === 'get') {
+                            const routeParams = req.routeParams ?? {};
+                            const searchParams = req.searchParams ? Object.fromEntries(req.searchParams.entries()) : {};
+                            const merged = {
+                                ...searchParams,
+                                ...routeParams
+                            };
+                            const result = inputSchema.safeParse(merged);
+                            if (!result.success) {
+                                return Response.json({
+                                    error: result.error
+                                }, {
+                                    status: 400
+                                });
+                            }
+                            // biome-ignore lint/complexity/noBannedTypes: ugly type cast
+                            const output = await handler(req, result.data);
+                            return wrapOutput(output);
+                        }
+                        const { addDataAndFileToRequest } = await import(/* webpackIgnore: true */ 'payload');
+                        await addDataAndFileToRequest(req);
+                        const result = inputSchema.safeParse(req.data);
+                        if (!result.success) {
+                            return Response.json({
+                                error: result.error
+                            }, {
+                                status: 400
+                            });
+                        }
+                        // biome-ignore lint/complexity/noBannedTypes: ugly type cast
+                        const output = await handler(req, result.data);
+                        return wrapOutput(output);
+                    }
+                    // biome-ignore lint/complexity/noBannedTypes: ugly type cast
+                    const output = await handler(req);
+                    return wrapOutput(output);
+                }
+            };
+        },
+        call (apiUrl, ...args) {
+            const input = args[0];
+            if (config.method === 'get') {
+                let resolvedPath = config.path;
+                const queryParams = {};
+                if (input) {
+                    for (const [key, value] of Object.entries(input)){
+                        if (resolvedPath.includes(`:${key}`)) {
+                            resolvedPath = resolvedPath.replace(`:${key}`, encodeURIComponent(String(value)));
+                        } else {
+                            queryParams[key] = String(value);
+                        }
+                    }
+                }
+                const queryString = new URLSearchParams(queryParams).toString();
+                const url = `${apiUrl}${resolvedPath}${queryString ? `?${queryString}` : ''}`;
+                return fetch(url, {
+                    method: 'GET',
+                    credentials: 'include'
+                }).then(async (response)=>{
+                    if (!response.ok) {
+                        throw new Error(`Request failed: ${response.status} ${response.statusText}`);
+                    }
+                    return response.json();
+                });
+            }
+            const url = `${apiUrl}${config.path}`;
+            return fetch(url, {
+                method: config.method.toUpperCase(),
+                credentials: 'include',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: input ? JSON.stringify(input) : undefined
+            }).then(async (response)=>{
+                if (!response.ok) {
+                    throw new Error(`Request failed: ${response.status} ${response.statusText}`);
+                }
+                return response.json();
+            });
+        }
+    };
+}
+export function defineProcedure(config) {
+    const proc = createProcedure(config, config.input);
+    return {
+        path: config.path,
+        method: config.method,
+        returns () {
+            return createProcedure(config, config.input);
+        },
+        endpoint: proc.endpoint,
+        call: proc.call
+    };
+}
+
+//# sourceMappingURL=procedure.js.map

package/dist/_common/procedure.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/_common/procedure.ts"],"sourcesContent":["import type { Endpoint, PayloadRequest } from 'payload';\n\ntype Method = 'get' | 'post' | 'put' | 'patch' | 'delete';\n\n/** Any Zod-like schema with safeParse and inferred output */\ninterface ZodLike<TOutput = unknown> {\n  safeParse(\n    data: unknown,\n  ): { success: true; data: TOutput } | { success: false; error: unknown };\n}\n\ntype InferOutput<T> = T extends ZodLike<infer O> ? O : never;\n\ninterface ProcedureConfig<TSchema extends ZodLike | undefined = undefined> {\n  path: `/${string}`;\n  method: Method;\n  input?: TSchema;\n}\n\nexport interface Procedure<TInput, TOutput> {\n  path: `/${string}`;\n  method: Method;\n  endpoint(\n    handler: (\n      req: PayloadRequest,\n      ...args: TInput extends void ? [] : [input: TInput]\n    ) => Promise<unknown | Response>,\n  ): Endpoint;\n  call(\n    apiUrl: string,\n    ...args: TInput extends void ? [] : [input: TInput]\n  ): Promise<TOutput>;\n}\n\nexport interface ProcedureBuilder<TInput> {\n  path: string;\n  method: Method;\n  returns<TOutput>(): Procedure<TInput, TOutput>;\n  endpoint(\n    handler: (\n      req: PayloadRequest,\n      ...args: TInput extends void ? [] : [input: TInput]\n    ) => Promise<unknown | Response>,\n  ): Endpoint;\n  call(\n    apiUrl: string,\n    ...args: TInput extends void ? [] : [input: TInput]\n  ): Promise<unknown>;\n}\n\nfunction wrapOutput(output: unknown): Response {\n  if (output instanceof Response) return output;\n  return Response.json(output);\n}\n\nfunction createProcedure<TInput, TOutput>(\n  config: ProcedureConfig<ZodLike | undefined>,\n  inputSchema: ZodLike | undefined,\n): Procedure<TInput, TOutput> {\n  return {\n    path: config.path,\n    method: config.method,\n    endpoint(handler) {\n      return {\n        path: config.path,\n        method: config.method,\n        handler: async (req) => {\n          if (inputSchema) {\n            if (config.method === 'get') {\n              const routeParams = req.routeParams ?? {};\n              const searchParams = req.searchParams\n                ? Object.fromEntries(req.searchParams.entries())\n                : {};\n              const merged = { ...searchParams, ...routeParams };\n              const result = inputSchema.safeParse(merged);\n              if (!result.success) {\n                return Response.json({ error: result.error }, { status: 400 });\n              }\n              // biome-ignore lint/complexity/noBannedTypes: ugly type cast\n              const output = await (handler as Function)(req, result.data);\n              return wrapOutput(output);\n            }\n\n            const { addDataAndFileToRequest } = await import(\n              /* webpackIgnore: true */ 'payload'\n            );\n            await addDataAndFileToRequest(req);\n            const result = inputSchema.safeParse(req.data);\n            if (!result.success) {\n              return Response.json({ error: result.error }, { status: 400 });\n            }\n            // biome-ignore lint/complexity/noBannedTypes: ugly type cast\n            const output = await (handler as Function)(req, result.data);\n            return wrapOutput(output);\n          }\n          // biome-ignore lint/complexity/noBannedTypes: ugly type cast\n          const output = await (handler as Function)(req);\n          return wrapOutput(output);\n        },\n      };\n    },\n    call(apiUrl, ...args) {\n      const input = args[0] as Record<string, unknown> | undefined;\n\n      if (config.method === 'get') {\n        let resolvedPath = config.path;\n        const queryParams: Record<string, string> = {};\n\n        if (input) {\n          for (const [key, value] of Object.entries(input)) {\n            if (resolvedPath.includes(`:${key}`)) {\n              resolvedPath = resolvedPath.replace(\n                `:${key}`,\n                encodeURIComponent(String(value)),\n              ) as `/${string}`;\n            } else {\n              queryParams[key] = String(value);\n            }\n          }\n        }\n\n        const queryString = new URLSearchParams(queryParams).toString();\n        const url = `${apiUrl}${resolvedPath}${queryString ? `?${queryString}` : ''}`;\n\n        return fetch(url, {\n          method: 'GET',\n          credentials: 'include',\n        }).then(async (response) => {\n          if (!response.ok) {\n            throw new Error(\n              `Request failed: ${response.status} ${response.statusText}`,\n            );\n          }\n          return response.json();\n        }) as Promise<TOutput>;\n      }\n\n      const url = `${apiUrl}${config.path}`;\n      return fetch(url, {\n        method: config.method.toUpperCase(),\n        credentials: 'include',\n        headers: { 'Content-Type': 'application/json' },\n        body: input ? JSON.stringify(input) : undefined,\n      }).then(async (response) => {\n        if (!response.ok) {\n          throw new Error(\n            `Request failed: ${response.status} ${response.statusText}`,\n          );\n        }\n        return response.json();\n      }) as Promise<TOutput>;\n    },\n  };\n}\n\nexport function defineProcedure<\n  TSchema extends ZodLike | undefined = undefined,\n>(\n  config: ProcedureConfig<TSchema>,\n): ProcedureBuilder<TSchema extends ZodLike ? InferOutput<TSchema> : void> {\n  type TInput = TSchema extends ZodLike ? InferOutput<TSchema> : undefined;\n  const proc = createProcedure<TInput, unknown>(config, config.input);\n\n  return {\n    path: config.path,\n    method: config.method,\n    returns<TOutput>(): Procedure<TInput, TOutput> {\n      return createProcedure<TInput, TOutput>(config, config.input);\n    },\n    endpoint: proc.endpoint as unknown as ProcedureBuilder<TInput>['endpoint'],\n    call: proc.call as ProcedureBuilder<TInput>['call'],\n  };\n}\n"],"names":["wrapOutput","output","Response","json","createProcedure","config","inputSchema","path","method","endpoint","handler","req","routeParams","searchParams","Object","fromEntries","entries","merged","result","safeParse","success","error","status","data","addDataAndFileToRequest","call","apiUrl","args","input","resolvedPath","queryParams","key","value","includes","replace","encodeURIComponent","String","queryString","URLSearchParams","toString","url","fetch","credentials","then","response","ok","Error","statusText","toUpperCase","headers","body","JSON","stringify","undefined","defineProcedure","proc","returns"],"mappings":"AAkDA,SAASA,WAAWC,MAAe;IACjC,IAAIA,kBAAkBC,UAAU,OAAOD;IACvC,OAAOC,SAASC,IAAI,CAACF;AACvB;AAEA,SAASG,gBACPC,MAA4C,EAC5CC,WAAgC;IAEhC,OAAO;QACLC,MAAMF,OAAOE,IAAI;QACjBC,QAAQH,OAAOG,MAAM;QACrBC,UAASC,OAAO;YACd,OAAO;gBACLH,MAAMF,OAAOE,IAAI;gBACjBC,QAAQH,OAAOG,MAAM;gBACrBE,SAAS,OAAOC;oBACd,IAAIL,aAAa;wBACf,IAAID,OAAOG,MAAM,KAAK,OAAO;4BAC3B,MAAMI,cAAcD,IAAIC,WAAW,IAAI,CAAC;4BACxC,MAAMC,eAAeF,IAAIE,YAAY,GACjCC,OAAOC,WAAW,CAACJ,IAAIE,YAAY,CAACG,OAAO,MAC3C,CAAC;4BACL,MAAMC,SAAS;gCAAE,GAAGJ,YAAY;gCAAE,GAAGD,WAAW;4BAAC;4BACjD,MAAMM,SAASZ,YAAYa,SAAS,CAACF;4BACrC,IAAI,CAACC,OAAOE,OAAO,EAAE;gCACnB,OAAOlB,SAASC,IAAI,CAAC;oCAAEkB,OAAOH,OAAOG,KAAK;gCAAC,GAAG;oCAAEC,QAAQ;gCAAI;4BAC9D;4BACA,6DAA6D;4BAC7D,MAAMrB,SAAS,MAAM,AAACS,QAAqBC,KAAKO,OAAOK,IAAI;4BAC3D,OAAOvB,WAAWC;wBACpB;wBAEA,MAAM,EAAEuB,uBAAuB,EAAE,GAAG,MAAM,MAAM,CAC9C,uBAAuB,GAAG;wBAE5B,MAAMA,wBAAwBb;wBAC9B,MAAMO,SAASZ,YAAYa,SAAS,CAACR,IAAIY,IAAI;wBAC7C,IAAI,CAACL,OAAOE,OAAO,EAAE;4BACnB,OAAOlB,SAASC,IAAI,CAAC;gCAAEkB,OAAOH,OAAOG,KAAK;4BAAC,GAAG;gCAAEC,QAAQ;4BAAI;wBAC9D;wBACA,6DAA6D;wBAC7D,MAAMrB,SAAS,MAAM,AAACS,QAAqBC,KAAKO,OAAOK,IAAI;wBAC3D,OAAOvB,WAAWC;oBACpB;oBACA,6DAA6D;oBAC7D,MAAMA,SAAS,MAAM,AAACS,QAAqBC;oBAC3C,OAAOX,WAAWC;gBACpB;YACF;QACF;QACAwB,MAAKC,MAAM,EAAE,GAAGC,IAAI;YAClB,MAAMC,QAAQD,IAAI,CAAC,EAAE;YAErB,IAAItB,OAAOG,MAAM,KAAK,OAAO;gBAC3B,IAAIqB,eAAexB,OAAOE,IAAI;gBAC9B,MAAMuB,cAAsC,CAAC;gBAE7C,IAAIF,OAAO;oBACT,KAAK,MAAM,CAACG,KAAKC,MAAM,IAAIlB,OAAOE,OAAO,CAACY,OAAQ;wBAChD,IAAIC,aAAaI,QAAQ,CAAC,CAAC,CAAC,EAAEF,KAAK,GAAG;4BACpCF,eAAeA,aAAaK,OAAO,CACjC,CAAC,CAAC,EAAEH,KAAK,EACTI,mBAAmBC,OAAOJ;wBAE9B,OAAO;4BACLF,WAAW,CAACC,IAAI,GAAGK,OAAOJ;wBAC5B;oBACF;gBACF;gBAEA,MAAMK,cAAc,IAAIC,gBAAgBR,aAAaS,QAAQ;gBAC7D,MAAMC,MAAM,GAAGd,SAASG,eAAeQ,cAAc,CAAC,CAAC,EAAEA,aAAa,GAAG,IAAI;gBAE7E,OAAOI,MAAMD,KAAK;oBAChBhC,QAAQ;oBACRkC,aAAa;gBACf,GAAGC,IAAI,CAAC,OAAOC;oBACb,IAAI,CAACA,SAASC,EAAE,EAAE;wBAChB,MAAM,IAAIC,MACR,CAAC,gBAAgB,EAAEF,SAAStB,MAAM,CAAC,CAAC,EAAEsB,SAASG,UAAU,EAAE;oBAE/D;oBACA,OAAOH,SAASzC,IAAI;gBACtB;YACF;YAEA,MAAMqC,MAAM,GAAGd,SAASrB,OAAOE,IAAI,EAAE;YACrC,OAAOkC,MAAMD,KAAK;gBAChBhC,QAAQH,OAAOG,MAAM,CAACwC,WAAW;gBACjCN,aAAa;gBACbO,SAAS;oBAAE,gBAAgB;gBAAmB;gBAC9CC,MAAMtB,QAAQuB,KAAKC,SAAS,CAACxB,SAASyB;YACxC,GAAGV,IAAI,CAAC,OAAOC;gBACb,IAAI,CAACA,SAASC,EAAE,EAAE;oBAChB,MAAM,IAAIC,MACR,CAAC,gBAAgB,EAAEF,SAAStB,MAAM,CAAC,CAAC,EAAEsB,SAASG,UAAU,EAAE;gBAE/D;gBACA,OAAOH,SAASzC,IAAI;YACtB;QACF;IACF;AACF;AAEA,OAAO,SAASmD,gBAGdjD,MAAgC;IAGhC,MAAMkD,OAAOnD,gBAAiCC,QAAQA,OAAOuB,KAAK;IAElE,OAAO;QACLrB,MAAMF,OAAOE,IAAI;QACjBC,QAAQH,OAAOG,MAAM;QACrBgD;YACE,OAAOpD,gBAAiCC,QAAQA,OAAOuB,KAAK;QAC9D;QACAnB,UAAU8C,KAAK9C,QAAQ;QACvBgB,MAAM8B,KAAK9B,IAAI;IACjB;AACF"}

package/dist/_common/urls.d.ts

@@ -0,0 +1,11 @@
+import type { PayloadRequest } from 'payload';
+export declare function getServerURL(req: PayloadRequest): string;
+export declare function getAdminURL({ req, path, }: {
+    req: PayloadRequest;
+    path?: '' | `/${string}` | null;
+}): string;
+export declare function getApiURL({ req, path, }: {
+    req: PayloadRequest;
+    path?: '' | `/${string}` | null;
+}): string;
+//# sourceMappingURL=urls.d.ts.map

package/dist/_common/urls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"urls.d.ts","sourceRoot":"","sources":["../../src/_common/urls.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAG9C,wBAAgB,YAAY,CAAC,GAAG,EAAE,cAAc,GAAG,MAAM,CAWxD;AAED,wBAAgB,WAAW,CAAC,EAC1B,GAAG,EACH,IAAI,GACL,EAAE;IACD,GAAG,EAAE,cAAc,CAAC;IACpB,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,MAAM,EAAE,GAAG,IAAI,CAAC;CACjC,GAAG,MAAM,CAMT;AAED,wBAAgB,SAAS,CAAC,EACxB,GAAG,EACH,IAAI,GACL,EAAE;IACD,GAAG,EAAE,cAAc,CAAC;IACpB,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,MAAM,EAAE,GAAG,IAAI,CAAC;CACjC,GAAG,MAAM,CAMT"}

package/dist/_common/urls.js

@@ -0,0 +1,23 @@
+import { formatAdminURL } from 'payload/shared';
+export function getServerURL(req) {
+    if (!req.url) throw new Error('Could not get serverURL, since request URL is not available');
+    const { config } = req.payload;
+    if (config.serverURL) return config.serverURL;
+    return `${new URL(req.url).protocol}//${req.headers.get('host')}`;
+}
+export function getAdminURL({ req, path }) {
+    return formatAdminURL({
+        adminRoute: req.payload.config.routes.admin,
+        serverURL: getServerURL(req),
+        path
+    });
+}
+export function getApiURL({ req, path }) {
+    return formatAdminURL({
+        apiRoute: req.payload.config.routes.api,
+        serverURL: getServerURL(req),
+        path
+    });
+}
+
+//# sourceMappingURL=urls.js.map

package/dist/_common/urls.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/_common/urls.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload';\nimport { formatAdminURL } from 'payload/shared';\n\nexport function getServerURL(req: PayloadRequest): string {\n  if (!req.url)\n    throw new Error(\n      'Could not get serverURL, since request URL is not available',\n    );\n\n  const { config } = req.payload;\n\n  if (config.serverURL) return config.serverURL;\n\n  return `${new URL(req.url).protocol}//${req.headers.get('host')}`;\n}\n\nexport function getAdminURL({\n  req,\n  path,\n}: {\n  req: PayloadRequest;\n  path?: '' | `/${string}` | null;\n}): string {\n  return formatAdminURL({\n    adminRoute: req.payload.config.routes.admin,\n    serverURL: getServerURL(req),\n    path,\n  });\n}\n\nexport function getApiURL({\n  req,\n  path,\n}: {\n  req: PayloadRequest;\n  path?: '' | `/${string}` | null;\n}): string {\n  return formatAdminURL({\n    apiRoute: req.payload.config.routes.api,\n    serverURL: getServerURL(req),\n    path,\n  });\n}\n"],"names":["formatAdminURL","getServerURL","req","url","Error","config","payload","serverURL","URL","protocol","headers","get","getAdminURL","path","adminRoute","routes","admin","getApiURL","apiRoute","api"],"mappings":"AACA,SAASA,cAAc,QAAQ,iBAAiB;AAEhD,OAAO,SAASC,aAAaC,GAAmB;IAC9C,IAAI,CAACA,IAAIC,GAAG,EACV,MAAM,IAAIC,MACR;IAGJ,MAAM,EAAEC,MAAM,EAAE,GAAGH,IAAII,OAAO;IAE9B,IAAID,OAAOE,SAAS,EAAE,OAAOF,OAAOE,SAAS;IAE7C,OAAO,GAAG,IAAIC,IAAIN,IAAIC,GAAG,EAAEM,QAAQ,CAAC,EAAE,EAAEP,IAAIQ,OAAO,CAACC,GAAG,CAAC,SAAS;AACnE;AAEA,OAAO,SAASC,YAAY,EAC1BV,GAAG,EACHW,IAAI,EAIL;IACC,OAAOb,eAAe;QACpBc,YAAYZ,IAAII,OAAO,CAACD,MAAM,CAACU,MAAM,CAACC,KAAK;QAC3CT,WAAWN,aAAaC;QACxBW;IACF;AACF;AAEA,OAAO,SAASI,UAAU,EACxBf,GAAG,EACHW,IAAI,EAIL;IACC,OAAOb,eAAe;QACpBkB,UAAUhB,IAAII,OAAO,CAACD,MAAM,CAACU,MAAM,CAACI,GAAG;QACvCZ,WAAWN,aAAaC;QACxBW;IACF;AACF"}

package/dist/_common/utils.d.ts

@@ -0,0 +1,5 @@
+import type { Field } from 'payload';
+export declare const uncaughtSwitchCase: (value: never) => never;
+export declare function findFields<T extends Field>(fields: Field[], condition: (field: Field) => field is T): T[];
+export declare function findFields(fields: Field[], condition: (field: Field) => boolean): Field[];
+//# sourceMappingURL=utils.d.ts.map

package/dist/_common/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/_common/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,kBAAkB,UAAW,KAAK,UAE9C,CAAC;AAEF,wBAAgB,UAAU,CAAC,CAAC,SAAS,KAAK,EACxC,MAAM,EAAE,KAAK,EAAE,EACf,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,IAAI,CAAC,GACtC,CAAC,EAAE,CAAC;AACP,wBAAgB,UAAU,CACxB,MAAM,EAAE,KAAK,EAAE,EACf,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GACnC,KAAK,EAAE,CAAC"}