payload 4.0.0-internal.e7d4ebc → 4.0.0-internal.ec73d44

package/skills/payload/reference/QUERIES.md

@@ -0,0 +1,282 @@
+# Payload Querying Reference
+
+Complete reference for querying data across Local API, REST, and GraphQL.
+
+## Query Operators
+
+```ts
+import type { Where } from 'payload'
+
+// Equals
+const equalsQuery: Where = { color: { equals: 'blue' } }
+
+// Not equals
+const notEqualsQuery: Where = { status: { not_equals: 'draft' } }
+
+// Greater/less than
+const greaterThanQuery: Where = { price: { greater_than: 100 } }
+const lessThanEqualQuery: Where = { age: { less_than_equal: 65 } }
+
+// Contains (case-insensitive)
+const containsQuery: Where = { title: { contains: 'payload' } }
+
+// Like (all words present)
+const likeQuery: Where = { description: { like: 'cms headless' } }
+
+// In/not in
+const inQuery: Where = { category: { in: ['tech', 'news'] } }
+
+// Exists
+const existsQuery: Where = { image: { exists: true } }
+
+// Near (point fields)
+const nearQuery: Where = { location: { near: '-122.4194,37.7749,10000' } }
+```
+
+## AND/OR Logic
+
+```ts
+import type { Where } from 'payload'
+
+const complexQuery: Where = {
+  or: [
+    { color: { equals: 'mint' } },
+    {
+      and: [{ color: { equals: 'white' } }, { featured: { equals: false } }],
+    },
+  ],
+}
+```
+
+## Nested Properties
+
+```ts
+import type { Where } from 'payload'
+
+const nestedQuery: Where = {
+  'author.role': { equals: 'editor' },
+  'meta.featured': { exists: true },
+}
+```
+
+## Local API
+
+```ts
+// Find documents
+const posts = await payload.find({
+  collection: 'posts',
+  overrideAccess: true,
+  where: {
+    status: { equals: 'published' },
+    'author.name': { contains: 'john' },
+  },
+  depth: 2,
+  limit: 10,
+  page: 1,
+  sort: '-createdAt',
+  locale: 'en',
+  select: {
+    title: true,
+    author: true,
+  },
+})
+
+// Find by ID
+const post = await payload.findByID({
+  collection: 'posts',
+  overrideAccess: true,
+  id: '123',
+  depth: 2,
+})
+
+// Create
+const post = await payload.create({
+  collection: 'posts',
+  overrideAccess: true,
+  data: {
+    title: 'New Post',
+    status: 'draft',
+  },
+})
+
+// Update
+await payload.update({
+  collection: 'posts',
+  overrideAccess: true,
+  id: '123',
+  data: {
+    status: 'published',
+  },
+})
+
+// Delete
+await payload.delete({
+  collection: 'posts',
+  overrideAccess: true,
+  id: '123',
+})
+
+// Count
+const count = await payload.count({
+  collection: 'posts',
+  overrideAccess: true,
+  where: {
+    status: { equals: 'published' },
+  },
+})
+```
+
+### Threading req Parameter
+
+When performing operations in hooks or nested operations, pass the `req` parameter to maintain transaction context:
+
+```ts
+// ✅ CORRECT: Pass req for transaction safety
+const afterChange: CollectionAfterChangeHook = async ({ doc, req }) => {
+  await req.payload.create({
+    collection: 'audit-log',
+    overrideAccess: true,
+    data: { action: 'created', docId: doc.id },
+    req, // Maintains transaction atomicity
+  })
+}
+
+// ❌ WRONG: Missing req breaks transaction
+const afterChange: CollectionAfterChangeHook = async ({ doc, req }) => {
+  await req.payload.create({
+    collection: 'audit-log',
+    overrideAccess: true,
+    data: { action: 'created', docId: doc.id },
+    // Missing req - runs in separate transaction
+  })
+}
+```
+
+This is critical for MongoDB replica sets and Postgres. See [ADAPTERS.md#threading-req-through-operations](ADAPTERS.md#threading-req-through-operations) for details.
+
+### Access Control in Local API
+
+**Important**: Where `overrideAccess` is optional, it defaults to `false` — Local API respects access control unless told otherwise. Set it to `true` to bypass access control.
+
+```ts
+// ❌ WRONG: User is passed but access control is bypassed anyway
+const posts = await payload.find({
+  collection: 'posts',
+  user: currentUser,
+  overrideAccess: true,
+  // Result: Operation runs with ADMIN privileges, ignoring user's permissions
+})
+
+// ✅ CORRECT: Respects user's access control permissions
+const posts = await payload.find({
+  collection: 'posts',
+  user: currentUser,
+  overrideAccess: false, // enforce access control
+  // Result: User only sees posts they have permission to read
+})
+
+// Administrative operation (intentionally bypass access control)
+const allPosts = await payload.find({
+  collection: 'posts',
+  // No user parameter
+  overrideAccess: true,
+  // Result: Returns all posts regardless of access control
+})
+```
+
+**When to use `overrideAccess: false`:**
+
+- Performing operations on behalf of a user
+- Testing access control logic
+- API routes that should respect user permissions
+- Any operation where `user` parameter is provided
+
+**When `overrideAccess: true` is appropriate:**
+
+- Administrative operations (migrations, seeds, cron jobs)
+- Internal system operations
+- Operations explicitly intended to bypass access control
+
+See [ACCESS-CONTROL.md#important-notes](ACCESS-CONTROL.md#important-notes) for more details.
+
+## REST API
+
+```ts
+import { stringify } from 'qs-esm'
+
+const query = {
+  status: { equals: 'published' },
+}
+
+const queryString = stringify(
+  {
+    where: query,
+    depth: 2,
+    limit: 10,
+  },
+  { addQueryPrefix: true },
+)
+
+const response = await fetch(`https://api.example.com/api/posts${queryString}`)
+const data = await response.json()
+```
+
+### REST Endpoints
+
+```txt
+GET    /api/{collection}           - Find documents
+GET    /api/{collection}/{id}      - Find by ID
+POST   /api/{collection}           - Create
+PATCH  /api/{collection}/{id}      - Update
+DELETE /api/{collection}/{id}      - Delete
+GET    /api/{collection}/count     - Count documents
+
+GET    /api/globals/{slug}         - Get global
+POST   /api/globals/{slug}         - Update global
+```
+
+## GraphQL
+
+```graphql
+query {
+  Posts(where: { status: { equals: published } }, limit: 10, sort: "-createdAt") {
+    docs {
+      id
+      title
+      author {
+        name
+      }
+    }
+    totalDocs
+    hasNextPage
+  }
+}
+
+mutation {
+  createPost(data: { title: "New Post", status: draft }) {
+    id
+    title
+  }
+}
+
+mutation {
+  updatePost(id: "123", data: { status: published }) {
+    id
+    status
+  }
+}
+
+mutation {
+  deletePost(id: "123") {
+    id
+  }
+}
+```
+
+## Performance Best Practices
+
+- Set `maxDepth` on relationships to prevent over-fetching
+- Use `select` to limit returned fields
+- Index frequently queried fields
+- Use `virtual` fields for computed data
+- Cache expensive operations in hook `context`

package/dist/auth/cookies.spec.js

@@ -1,34 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { parseCookies } from './cookies.js';
-describe('parseCookies', ()=>{
-    it('parses cookie attributes without values', ()=>{
-        const fakeHeaders = new Map();
-        fakeHeaders.set('Cookie', 'my_value=true; Secure; HttpOnly');
-        const parsed = parseCookies(fakeHeaders);
-        expect(parsed.get('my_value')).toBe('true');
-        expect(parsed.get('Secure')).toBe('true');
-        expect(parsed.get('HttpOnly')).toBe('true');
-        expect(parsed.size).toBe(3);
-    });
-    it('strips whitespace', ()=>{
-        const fakeHeaders = new Map();
-        fakeHeaders.set('Cookie', 'my_value=true; ');
-        const parsed = parseCookies(fakeHeaders);
-        expect(parsed.get('my_value')).toBe('true');
-        expect(parsed.size).toBe(1);
-    });
-    it('ensure invalid cookies are ignored', ()=>{
-        const fakeHeaders = new Map();
-        fakeHeaders.set('Cookie', 'my_value=true; invalid_cookie=%E0%A4%A');
-        const parsed = parseCookies(fakeHeaders);
-        expect(parsed.get('my_value')).toBe('true');
-        expect(parsed.size).toBe(1);
-    });
-    it('ensure empty map is returned if there are no cookies', ()=>{
-        const fakeHeaders = new Map();
-        const parsed = parseCookies(fakeHeaders);
-        expect(parsed.size).toBe(0);
-    });
-});
-
-//# sourceMappingURL=cookies.spec.js.map

package/dist/auth/cookies.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/auth/cookies.spec.ts"],"sourcesContent":["import { describe, it, expect } from 'vitest'\nimport { parseCookies } from './cookies.js'\n\ndescribe('parseCookies', () => {\n  it('parses cookie attributes without values', () => {\n    const fakeHeaders = new Map()\n    fakeHeaders.set('Cookie', 'my_value=true; Secure; HttpOnly')\n\n    const parsed = parseCookies(fakeHeaders as unknown as Request['headers'])\n\n    expect(parsed.get('my_value')).toBe('true')\n    expect(parsed.get('Secure')).toBe('true')\n    expect(parsed.get('HttpOnly')).toBe('true')\n    expect(parsed.size).toBe(3)\n  })\n  it('strips whitespace', () => {\n    const fakeHeaders = new Map()\n    fakeHeaders.set('Cookie', 'my_value=true; ')\n\n    const parsed = parseCookies(fakeHeaders as unknown as Request['headers'])\n\n    expect(parsed.get('my_value')).toBe('true')\n    expect(parsed.size).toBe(1)\n  })\n\n  it('ensure invalid cookies are ignored', () => {\n    const fakeHeaders = new Map()\n    fakeHeaders.set('Cookie', 'my_value=true; invalid_cookie=%E0%A4%A')\n\n    const parsed = parseCookies(fakeHeaders as unknown as Request['headers'])\n\n    expect(parsed.get('my_value')).toBe('true')\n    expect(parsed.size).toBe(1)\n  })\n\n  it('ensure empty map is returned if there are no cookies', () => {\n    const fakeHeaders = new Map()\n\n    const parsed = parseCookies(fakeHeaders as unknown as Request['headers'])\n\n    expect(parsed.size).toBe(0)\n  })\n})\n"],"names":["describe","it","expect","parseCookies","fakeHeaders","Map","set","parsed","get","toBe","size"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,EAAE,EAAEC,MAAM,QAAQ,SAAQ;AAC7C,SAASC,YAAY,QAAQ,eAAc;AAE3CH,SAAS,gBAAgB;IACvBC,GAAG,2CAA2C;QAC5C,MAAMG,cAAc,IAAIC;QACxBD,YAAYE,GAAG,CAAC,UAAU;QAE1B,MAAMC,SAASJ,aAAaC;QAE5BF,OAAOK,OAAOC,GAAG,CAAC,aAAaC,IAAI,CAAC;QACpCP,OAAOK,OAAOC,GAAG,CAAC,WAAWC,IAAI,CAAC;QAClCP,OAAOK,OAAOC,GAAG,CAAC,aAAaC,IAAI,CAAC;QACpCP,OAAOK,OAAOG,IAAI,EAAED,IAAI,CAAC;IAC3B;IACAR,GAAG,qBAAqB;QACtB,MAAMG,cAAc,IAAIC;QACxBD,YAAYE,GAAG,CAAC,UAAU;QAE1B,MAAMC,SAASJ,aAAaC;QAE5BF,OAAOK,OAAOC,GAAG,CAAC,aAAaC,IAAI,CAAC;QACpCP,OAAOK,OAAOG,IAAI,EAAED,IAAI,CAAC;IAC3B;IAEAR,GAAG,sCAAsC;QACvC,MAAMG,cAAc,IAAIC;QACxBD,YAAYE,GAAG,CAAC,UAAU;QAE1B,MAAMC,SAASJ,aAAaC;QAE5BF,OAAOK,OAAOC,GAAG,CAAC,aAAaC,IAAI,CAAC;QACpCP,OAAOK,OAAOG,IAAI,EAAED,IAAI,CAAC;IAC3B;IAEAR,GAAG,wDAAwD;QACzD,MAAMG,cAAc,IAAIC;QAExB,MAAME,SAASJ,aAAaC;QAE5BF,OAAOK,OAAOG,IAAI,EAAED,IAAI,CAAC;IAC3B;AACF"}

package/dist/auth/strategies/local/authenticate.spec.js

@@ -1,83 +0,0 @@
-import crypto from 'crypto';
-import { describe, expect, it } from 'vitest';
-import { authenticateLocalStrategy } from './authenticate.js';
-// Helper to generate hash/salt like Payload does
-const generateHashAndSalt = (password)=>{
-    const salt = crypto.randomBytes(32).toString('hex');
-    const hash = crypto.pbkdf2Sync(password, salt, 25000, 512, 'sha256').toString('hex');
-    return {
-        hash,
-        salt
-    };
-};
-describe('authenticateLocalStrategy', ()=>{
-    it('should return doc when password is valid', async ()=>{
-        const password = 'test-password';
-        const { hash, salt } = generateHashAndSalt(password);
-        const doc = {
-            id: 1,
-            hash,
-            salt
-        };
-        const result = await authenticateLocalStrategy({
-            doc,
-            password
-        });
-        expect(result).toEqual(doc);
-    });
-    it('should return null when password is invalid', async ()=>{
-        const { hash, salt } = generateHashAndSalt('correct-password');
-        const doc = {
-            id: 1,
-            hash,
-            salt
-        };
-        const result = await authenticateLocalStrategy({
-            doc,
-            password: 'wrong-password'
-        });
-        expect(result).toBeNull();
-    });
-    it('should return null when salt is missing', async ()=>{
-        const { hash } = generateHashAndSalt('test-password');
-        const doc = {
-            id: 1,
-            hash
-        };
-        const result = await authenticateLocalStrategy({
-            doc,
-            password: 'test-password'
-        });
-        expect(result).toBeNull();
-    });
-    it('should return null when hash is missing', async ()=>{
-        const { salt } = generateHashAndSalt('test-password');
-        const doc = {
-            id: 1,
-            salt
-        };
-        const result = await authenticateLocalStrategy({
-            doc,
-            password: 'test-password'
-        });
-        expect(result).toBeNull();
-    });
-    it('should return null when hash has different length (tampered)', async ()=>{
-        const password = 'test-password';
-        const { salt } = generateHashAndSalt(password);
-        // Truncated hash - different length than expected 512 bytes
-        const shortHash = 'abcd1234';
-        const doc = {
-            id: 1,
-            hash: shortHash,
-            salt
-        };
-        const result = await authenticateLocalStrategy({
-            doc,
-            password
-        });
-        expect(result).toBeNull();
-    });
-});
-
-//# sourceMappingURL=authenticate.spec.js.map

package/dist/auth/strategies/local/authenticate.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/auth/strategies/local/authenticate.spec.ts"],"sourcesContent":["import crypto from 'crypto'\n\nimport { describe, expect, it } from 'vitest'\n\nimport { authenticateLocalStrategy } from './authenticate.js'\n\n// Helper to generate hash/salt like Payload does\nconst generateHashAndSalt = (password: string): { hash: string; salt: string } => {\n  const salt = crypto.randomBytes(32).toString('hex')\n  const hash = crypto.pbkdf2Sync(password, salt, 25000, 512, 'sha256').toString('hex')\n  return { hash, salt }\n}\n\ndescribe('authenticateLocalStrategy', () => {\n  it('should return doc when password is valid', async () => {\n    const password = 'test-password'\n    const { hash, salt } = generateHashAndSalt(password)\n    const doc = { id: 1, hash, salt }\n\n    const result = await authenticateLocalStrategy({ doc, password })\n\n    expect(result).toEqual(doc)\n  })\n\n  it('should return null when password is invalid', async () => {\n    const { hash, salt } = generateHashAndSalt('correct-password')\n    const doc = { id: 1, hash, salt }\n\n    const result = await authenticateLocalStrategy({ doc, password: 'wrong-password' })\n\n    expect(result).toBeNull()\n  })\n\n  it('should return null when salt is missing', async () => {\n    const { hash } = generateHashAndSalt('test-password')\n    const doc = { id: 1, hash }\n\n    const result = await authenticateLocalStrategy({ doc, password: 'test-password' })\n\n    expect(result).toBeNull()\n  })\n\n  it('should return null when hash is missing', async () => {\n    const { salt } = generateHashAndSalt('test-password')\n    const doc = { id: 1, salt }\n\n    const result = await authenticateLocalStrategy({ doc, password: 'test-password' })\n\n    expect(result).toBeNull()\n  })\n\n  it('should return null when hash has different length (tampered)', async () => {\n    const password = 'test-password'\n    const { salt } = generateHashAndSalt(password)\n    // Truncated hash - different length than expected 512 bytes\n    const shortHash = 'abcd1234'\n    const doc = { id: 1, hash: shortHash, salt }\n\n    const result = await authenticateLocalStrategy({ doc, password })\n\n    expect(result).toBeNull()\n  })\n})\n"],"names":["crypto","describe","expect","it","authenticateLocalStrategy","generateHashAndSalt","password","salt","randomBytes","toString","hash","pbkdf2Sync","doc","id","result","toEqual","toBeNull","shortHash"],"mappings":"AAAA,OAAOA,YAAY,SAAQ;AAE3B,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAQ;AAE7C,SAASC,yBAAyB,QAAQ,oBAAmB;AAE7D,iDAAiD;AACjD,MAAMC,sBAAsB,CAACC;IAC3B,MAAMC,OAAOP,OAAOQ,WAAW,CAAC,IAAIC,QAAQ,CAAC;IAC7C,MAAMC,OAAOV,OAAOW,UAAU,CAACL,UAAUC,MAAM,OAAO,KAAK,UAAUE,QAAQ,CAAC;IAC9E,OAAO;QAAEC;QAAMH;IAAK;AACtB;AAEAN,SAAS,6BAA6B;IACpCE,GAAG,4CAA4C;QAC7C,MAAMG,WAAW;QACjB,MAAM,EAAEI,IAAI,EAAEH,IAAI,EAAE,GAAGF,oBAAoBC;QAC3C,MAAMM,MAAM;YAAEC,IAAI;YAAGH;YAAMH;QAAK;QAEhC,MAAMO,SAAS,MAAMV,0BAA0B;YAAEQ;YAAKN;QAAS;QAE/DJ,OAAOY,QAAQC,OAAO,CAACH;IACzB;IAEAT,GAAG,+CAA+C;QAChD,MAAM,EAAEO,IAAI,EAAEH,IAAI,EAAE,GAAGF,oBAAoB;QAC3C,MAAMO,MAAM;YAAEC,IAAI;YAAGH;YAAMH;QAAK;QAEhC,MAAMO,SAAS,MAAMV,0BAA0B;YAAEQ;YAAKN,UAAU;QAAiB;QAEjFJ,OAAOY,QAAQE,QAAQ;IACzB;IAEAb,GAAG,2CAA2C;QAC5C,MAAM,EAAEO,IAAI,EAAE,GAAGL,oBAAoB;QACrC,MAAMO,MAAM;YAAEC,IAAI;YAAGH;QAAK;QAE1B,MAAMI,SAAS,MAAMV,0BAA0B;YAAEQ;YAAKN,UAAU;QAAgB;QAEhFJ,OAAOY,QAAQE,QAAQ;IACzB;IAEAb,GAAG,2CAA2C;QAC5C,MAAM,EAAEI,IAAI,EAAE,GAAGF,oBAAoB;QACrC,MAAMO,MAAM;YAAEC,IAAI;YAAGN;QAAK;QAE1B,MAAMO,SAAS,MAAMV,0BAA0B;YAAEQ;YAAKN,UAAU;QAAgB;QAEhFJ,OAAOY,QAAQE,QAAQ;IACzB;IAEAb,GAAG,gEAAgE;QACjE,MAAMG,WAAW;QACjB,MAAM,EAAEC,IAAI,EAAE,GAAGF,oBAAoBC;QACrC,4DAA4D;QAC5D,MAAMW,YAAY;QAClB,MAAML,MAAM;YAAEC,IAAI;YAAGH,MAAMO;YAAWV;QAAK;QAE3C,MAAMO,SAAS,MAAMV,0BAA0B;YAAEQ;YAAKN;QAAS;QAE/DJ,OAAOY,QAAQE,QAAQ;IACzB;AACF"}

package/dist/bin/build.d.ts

@@ -1,49 +0,0 @@
-import type { SanitizedConfig } from '../config/types.js';
-type Framework = 'next' | 'tanstack-start';
-/**
- * `payload build` — generate the import map (and types) so they are on disk
- * before the framework build statically imports them, then detect the project's
- * framework (Next.js or TanStack Start) and run its build, forwarding any extra
- * CLI args verbatim.
- *
- * Owns its own process lifecycle: it exits with the framework build's exit code,
- * or exits 1 if pre-build generation or framework detection fails (never builds
- * against a stale map or the wrong bundler).
- */
-export declare function build({ config }: {
-    config: SanitizedConfig;
-}): Promise<void>;
-/**
- * Determine whether the project builds with Next.js or TanStack Start. An explicit
- * `PAYLOAD_FRAMEWORK` env wins; otherwise tries the most intentional signals first
- * — declared dependencies, then framework config files, then Payload's
- * admin-route folder conventions — falling through when a layer is inconclusive.
- * Throws with guidance for an unsupported override or when no single framework can
- * be determined.
- */
-export declare function detectFramework(cwd?: string): Framework;
-/** Resolve the project's `next` binary — see {@link resolveBin}. */
-export declare function resolveNextBin(cwd?: string): string;
-/** Resolve the project's `vite` binary — see {@link resolveBin}. */
-export declare function resolveViteBin(cwd?: string): string;
-/**
- * Map a detected framework to the resolved binary and argument list to spawn.
- * Both frameworks take the `build` subcommand followed by the forwarded args.
- */
-export declare function resolveBuildCommand({ cwd, forwardedArgs, framework, }: {
-    cwd?: string;
-    forwardedArgs: string[];
-    framework: Framework;
-}): {
-    args: string[];
-    bin: string;
-};
-/**
- * Forward the raw args that follow the `build` subcommand to the framework build
- * (`next build` / `vite build`), dropping payload-only flags. Uses raw argv (not
- * minimist) so flags like `--turbopack` (Next) or `--mode staging` (Vite) pass
- * through verbatim.
- */
-export declare function getForwardedArgs(argv?: string[]): string[];
-export {};
-//# sourceMappingURL=build.d.ts.map

package/dist/bin/build.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/bin/build.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAMzD,KAAK,SAAS,GAAG,MAAM,GAAG,gBAAgB,CAAA;AAY1C;;;;;;;;;GASG;AACH,wBAAsB,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE;IAAE,MAAM,EAAE,eAAe,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAuClF;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,GAAG,GAAE,MAAsB,GAAG,SAAS,CAuDtE;AAED,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,GAAG,GAAE,MAAsB,GAAG,MAAM,CAElE;AAED,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,GAAG,GAAE,MAAsB,GAAG,MAAM,CAElE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,GAAmB,EACnB,aAAa,EACb,SAAS,GACV,EAAE;IACD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,SAAS,EAAE,SAAS,CAAA;CACrB,GAAG;IAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAGlC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,GAAE,MAAM,EAA0B,GAAG,MAAM,EAAE,CAIjF"}

package/dist/bin/build.js

@@ -1,226 +0,0 @@
-/* eslint-disable no-console */ import { spawn } from 'node:child_process';
-import fs, { readFileSync } from 'node:fs';
-import { createRequire } from 'node:module';
-import path from 'node:path';
-import { NEXT_PAYLOAD_ROUTE_GROUP, TANSTACK_PAYLOAD_DIR } from './frameworkConventions.js';
-import { generateImportMap } from './generateImportMap/index.js';
-import { generateTypes } from './generateTypes.js';
-const NEXT_CONFIG_FILES = [
-    'next.config.js',
-    'next.config.ts',
-    'next.config.mjs',
-    'next.config.cjs'
-];
-const VITE_CONFIG_FILES = [
-    'vite.config.js',
-    'vite.config.ts',
-    'vite.config.mjs',
-    'vite.config.cjs',
-    'vite.config.cts',
-    'vite.config.mts'
-];
-/**
- * `payload build` — generate the import map (and types) so they are on disk
- * before the framework build statically imports them, then detect the project's
- * framework (Next.js or TanStack Start) and run its build, forwarding any extra
- * CLI args verbatim.
- *
- * Owns its own process lifecycle: it exits with the framework build's exit code,
- * or exits 1 if pre-build generation or framework detection fails (never builds
- * against a stale map or the wrong bundler).
- */ export async function build({ config }) {
-    const skipTypes = process.argv.includes('--no-types');
-    try {
-        await generateImportMap(config, {
-            log: true
-        });
-        if (!skipTypes) {
-            await generateTypes(config, {
-                log: true
-            });
-        }
-    } catch (err) {
-        console.error('Pre-build generation failed:');
-        console.error(err);
-        return process.exit(1);
-    }
-    let bin;
-    let args;
-    try {
-        const framework = detectFramework();
-        ({ args, bin } = resolveBuildCommand({
-            forwardedArgs: getForwardedArgs(),
-            framework
-        }));
-    } catch (err) {
-        console.error(err instanceof Error ? err.message : err);
-        return process.exit(1);
-    }
-    const exitCode = await new Promise((resolve)=>{
-        const child = spawn(process.execPath, [
-            bin,
-            ...args
-        ], {
-            stdio: 'inherit'
-        });
-        child.on('error', (err)=>{
-            console.error('Failed to run build:');
-            console.error(err);
-            resolve(1);
-        });
-        child.on('exit', (code)=>{
-            resolve(code ?? 0);
-        });
-    });
-    process.exit(exitCode);
-}
-/**
- * Determine whether the project builds with Next.js or TanStack Start. An explicit
- * `PAYLOAD_FRAMEWORK` env wins; otherwise tries the most intentional signals first
- * — declared dependencies, then framework config files, then Payload's
- * admin-route folder conventions — falling through when a layer is inconclusive.
- * Throws with guidance for an unsupported override or when no single framework can
- * be determined.
- */ export function detectFramework(cwd = process.cwd()) {
-    const override = process.env.PAYLOAD_FRAMEWORK;
-    if (override) {
-        if (isFramework(override)) {
-            return override;
-        }
-        throw new Error(`PAYLOAD_FRAMEWORK is set to "${override}", which is not supported. Use one of: next, tanstack-start.`);
-    }
-    const deps = readProjectDependencies(cwd);
-    const hasNextDep = Boolean(deps.next);
-    const hasTanstackDep = Boolean(deps['@tanstack/react-start']);
-    if (hasNextDep && !hasTanstackDep) {
-        return 'next';
-    }
-    if (hasTanstackDep && !hasNextDep) {
-        return 'tanstack-start';
-    }
-    const hasNextConfig = NEXT_CONFIG_FILES.some((file)=>fs.existsSync(path.join(cwd, file)));
-    const hasViteConfig = VITE_CONFIG_FILES.some((file)=>fs.existsSync(path.join(cwd, file)));
-    if (hasNextConfig && !hasViteConfig) {
-        return 'next';
-    }
-    if (hasViteConfig && !hasNextConfig) {
-        return 'tanstack-start';
-    }
-    const hasNextFolder = [
-        path.join(cwd, 'app', NEXT_PAYLOAD_ROUTE_GROUP),
-        path.join(cwd, 'src', 'app', NEXT_PAYLOAD_ROUTE_GROUP)
-    ].some((dir)=>fs.existsSync(dir));
-    const hasTanstackFolder = [
-        path.join(cwd, 'app', TANSTACK_PAYLOAD_DIR),
-        path.join(cwd, 'src', 'app', TANSTACK_PAYLOAD_DIR)
-    ].some((dir)=>fs.existsSync(dir));
-    if (hasNextFolder && !hasTanstackFolder) {
-        return 'next';
-    }
-    if (hasTanstackFolder && !hasNextFolder) {
-        return 'tanstack-start';
-    }
-    throw new Error(buildDetectionError({
-        hasNextConfig,
-        hasNextDep,
-        hasNextFolder,
-        hasTanstackDep,
-        hasTanstackFolder,
-        hasViteConfig
-    }));
-}
-/** Resolve the project's `next` binary — see {@link resolveBin}. */ export function resolveNextBin(cwd = process.cwd()) {
-    return resolveBin({
-        cwd,
-        displayName: 'Next.js',
-        packageName: 'next'
-    });
-}
-/** Resolve the project's `vite` binary — see {@link resolveBin}. */ export function resolveViteBin(cwd = process.cwd()) {
-    return resolveBin({
-        cwd,
-        displayName: 'Vite',
-        packageName: 'vite'
-    });
-}
-/**
- * Map a detected framework to the resolved binary and argument list to spawn.
- * Both frameworks take the `build` subcommand followed by the forwarded args.
- */ export function resolveBuildCommand({ cwd = process.cwd(), forwardedArgs, framework }) {
-    const bin = framework === 'next' ? resolveNextBin(cwd) : resolveViteBin(cwd);
-    return {
-        args: [
-            'build',
-            ...forwardedArgs
-        ],
-        bin
-    };
-}
-/**
- * Forward the raw args that follow the `build` subcommand to the framework build
- * (`next build` / `vite build`), dropping payload-only flags. Uses raw argv (not
- * minimist) so flags like `--turbopack` (Next) or `--mode staging` (Vite) pass
- * through verbatim.
- */ export function getForwardedArgs(argv = process.argv.slice(2)) {
-    const buildIndex = argv.indexOf('build');
-    const rest = buildIndex === -1 ? argv : argv.slice(buildIndex + 1);
-    return rest.filter((arg)=>arg !== '--no-types');
-}
-function isFramework(value) {
-    return value === 'next' || value === 'tanstack-start';
-}
-function readProjectDependencies(cwd) {
-    try {
-        const pkg = JSON.parse(readFileSync(path.join(cwd, 'package.json'), 'utf8'));
-        return {
-            ...pkg.dependencies,
-            ...pkg.devDependencies
-        };
-    } catch  {
-        return {};
-    }
-}
-function buildDetectionError(signals) {
-    const conflicts = [];
-    if (signals.hasNextDep && signals.hasTanstackDep) {
-        conflicts.push('dependencies (`next` and `@tanstack/react-start`)');
-    }
-    if (signals.hasNextConfig && signals.hasViteConfig) {
-        conflicts.push('config files (next.config.* and vite.config.*)');
-    }
-    if (signals.hasNextFolder && signals.hasTanstackFolder) {
-        conflicts.push('app folders (app/(payload) and app/_payload)');
-    }
-    if (conflicts.length) {
-        return `Could not determine your framework for \`payload build\`: conflicting signals found in ${conflicts.join(', ')}. Resolve the conflict so only one framework is indicated.`;
-    }
-    return [
-        'Could not determine your framework for `payload build`.',
-        'Checked:',
-        '  • dependencies: no `next` or `@tanstack/react-start` in package.json',
-        '  • config files: no next.config.* or vite.config.*',
-        '  • app folders:  no app/(payload) or app/_payload',
-        'Install your framework (Next.js or TanStack Start) and try again.'
-    ].join('\n');
-}
-/**
- * Resolve a framework's binary path from its own package manifest, robust to a
- * future `exports` field and to internal layout changes. Resolving from `cwd`
- * (not PATH) works whether `payload build` runs via an npm script or `npx`.
- */ function resolveBin({ cwd, displayName, packageName }) {
-    const require = createRequire(path.join(cwd, 'package.json'));
-    let pkgPath;
-    try {
-        pkgPath = require.resolve(`${packageName}/package.json`);
-    } catch  {
-        throw new Error(`Could not resolve "${packageName}" from the current project. Is ${displayName} installed?`);
-    }
-    const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'));
-    const binField = typeof pkg.bin === 'string' ? pkg.bin : pkg.bin?.[packageName];
-    if (!binField) {
-        throw new Error(`Could not determine the "${packageName}" binary path from ${packageName}/package.json.`);
-    }
-    return path.join(path.dirname(pkgPath), binField);
-}
-
-//# sourceMappingURL=build.js.map