@payloadcms/figma 0.0.1-alpha.3 → 0.0.1-alpha.30

package/dist/config/oauth.js

@@ -1,4 +1,8 @@
 import { FIGMA_CLIENT_IDS } from '../constants.js';
+/**
+ * Default port for OAuth callback server
+ * Using a high port (34462) to avoid conflicts with common dev servers (3000, 8080, etc.)
+ */ export const DEFAULT_CALLBACK_PORT = 34462;
 export const URLS = {
     prod: {
         authorizationUrl: 'https://www.figma.com/oauth',
@@ -6,9 +10,10 @@ export const URLS = {
         tokenUrl: 'https://api.figma.com/v1/oauth/token'
     },
     staging: {
-        authorizationUrl: 'https://staging.figma.com/oauth',
-        refreshUrl: 'https://api.staging.figma.com/v1/oauth/refresh',
-        tokenUrl: 'https://api.staging.figma.com/v1/oauth/token'
+        authorizationUrl: process.env.FIGMA_AUTH_URL ? `${process.env.FIGMA_AUTH_URL}/oauth` // TODO: Might need to add /cms here based on recent changes
+         : 'https://staging.figma.com/oauth',
+        refreshUrl: process.env.FIGMA_API_URL ? `${process.env.FIGMA_API_URL}/v1/oauth/refresh` : 'https://api.staging.figma.com/v1/oauth/refresh',
+        tokenUrl: process.env.FIGMA_API_URL ? `${process.env.FIGMA_API_URL}/v1/oauth/token` : 'https://api.staging.figma.com/v1/oauth/token'
     }
 };
 /**
@@ -26,7 +31,7 @@ export const URLS = {
     clientId: process.env.FIGMA_CLIENT_ID || FIGMA_CLIENT_IDS.staging,
     // No client secret - this is a public OAuth client using PKCE
     // Public clients cannot securely store secrets in CLI environments
-    redirectUri: process.env.FIGMA_REDIRECT_URI || 'http://localhost:3000/callback',
+    redirectUri: process.env.FIGMA_REDIRECT_URI || `http://localhost:${DEFAULT_CALLBACK_PORT}/callback`,
     // Only current_user:read scope is needed for basic user info
     scopes: [
         'current_user:read'

package/dist/config/oauth.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/config/oauth.ts"],"sourcesContent":["import type { OAuthConfig } from '../auth/types.js'\n\nimport { FIGMA_CLIENT_IDS } from '../constants.js'\n\nexport const URLS: Record<\n  'prod' | 'staging',\n  Pick<OAuthConfig, 'authorizationUrl' | 'refreshUrl' | 'tokenUrl'>\n> = {\n  prod: {\n    authorizationUrl: 'https://www.figma.com/oauth',\n    refreshUrl: 'https://api.figma.com/v1/oauth/refresh',\n    tokenUrl: 'https://api.figma.com/v1/oauth/token',\n  },\n  staging: {\n    authorizationUrl: 'https://staging.figma.com/oauth',\n    refreshUrl: 'https://api.staging.figma.com/v1/oauth/refresh',\n    tokenUrl: 'https://api.staging.figma.com/v1/oauth/token',\n  },\n}\n\n/**\n * Figma OAuth2 configuration for public CLI client\n *\n * This is a PUBLIC OAuth client using PKCE (Proof Key for Code Exchange).\n * No client secret is used because CLIs cannot securely store secrets.\n * PKCE provides security through the code_verifier/code_challenge mechanism.\n *\n * For production use, register a public OAuth app with Figma.\n * To register an OAuth app, visit: https://www.figma.com/developers/api#oauth2\n */\nexport const OAUTH_CONFIG: OAuthConfig = {\n  // OAuth client ID (public client)\n  // Uses staging client ID by default since we use staging endpoints\n  clientId: process.env.FIGMA_CLIENT_ID || FIGMA_CLIENT_IDS.staging,\n\n  // No client secret - this is a public OAuth client using PKCE\n  // Public clients cannot securely store secrets in CLI environments\n\n  redirectUri: process.env.FIGMA_REDIRECT_URI || 'http://localhost:3000/callback',\n\n  // Only current_user:read scope is needed for basic user info\n  scopes: ['current_user:read'],\n\n  // TODO: Dynamically choose between prod and staging based on environment\n  ...URLS.staging,\n}\n\n/**\n * Buffer time (in seconds) before token expiration to consider token as expired\n * This helps avoid using tokens that are about to expire\n */\nexport const TOKEN_EXPIRY_BUFFER_SECONDS = 300 // 5 minutes\n"],"names":["FIGMA_CLIENT_IDS","URLS","prod","authorizationUrl","refreshUrl","tokenUrl","staging","OAUTH_CONFIG","clientId","process","env","FIGMA_CLIENT_ID","redirectUri","FIGMA_REDIRECT_URI","scopes","TOKEN_EXPIRY_BUFFER_SECONDS"],"mappings":"AAEA,SAASA,gBAAgB,QAAQ,kBAAiB;AAElD,OAAO,MAAMC,OAGT;IACFC,MAAM;QACJC,kBAAkB;QAClBC,YAAY;QACZC,UAAU;IACZ;IACAC,SAAS;QACPH,kBAAkB;QAClBC,YAAY;QACZC,UAAU;IACZ;AACF,EAAC;AAED;;;;;;;;;CASC,GACD,OAAO,MAAME,eAA4B;IACvC,kCAAkC;IAClC,mEAAmE;IACnEC,UAAUC,QAAQC,GAAG,CAACC,eAAe,IAAIX,iBAAiBM,OAAO;IAEjE,8DAA8D;IAC9D,mEAAmE;IAEnEM,aAAaH,QAAQC,GAAG,CAACG,kBAAkB,IAAI;IAE/C,6DAA6D;IAC7DC,QAAQ;QAAC;KAAoB;IAE7B,yEAAyE;IACzE,GAAGb,KAAKK,OAAO;AACjB,EAAC;AAED;;;CAGC,GACD,OAAO,MAAMS,8BAA8B,IAAI,YAAY;CAAb"}
+{"version":3,"sources":["../../src/config/oauth.ts"],"sourcesContent":["import type { OAuthConfig } from '../auth/types.js'\n\nimport { FIGMA_CLIENT_IDS } from '../constants.js'\n\n/**\n * Default port for OAuth callback server\n * Using a high port (34462) to avoid conflicts with common dev servers (3000, 8080, etc.)\n */\nexport const DEFAULT_CALLBACK_PORT = 34462\n\nexport const URLS: Record<\n  'prod' | 'staging',\n  Pick<OAuthConfig, 'authorizationUrl' | 'refreshUrl' | 'tokenUrl'>\n> = {\n  prod: {\n    authorizationUrl: 'https://www.figma.com/oauth',\n    refreshUrl: 'https://api.figma.com/v1/oauth/refresh',\n    tokenUrl: 'https://api.figma.com/v1/oauth/token',\n  },\n  staging: {\n    authorizationUrl: process.env.FIGMA_AUTH_URL\n      ? `${process.env.FIGMA_AUTH_URL}/oauth` // TODO: Might need to add /cms here based on recent changes\n      : 'https://staging.figma.com/oauth',\n    refreshUrl: process.env.FIGMA_API_URL\n      ? `${process.env.FIGMA_API_URL}/v1/oauth/refresh`\n      : 'https://api.staging.figma.com/v1/oauth/refresh',\n    tokenUrl: process.env.FIGMA_API_URL\n      ? `${process.env.FIGMA_API_URL}/v1/oauth/token`\n      : 'https://api.staging.figma.com/v1/oauth/token',\n  },\n}\n\n/**\n * Figma OAuth2 configuration for public CLI client\n *\n * This is a PUBLIC OAuth client using PKCE (Proof Key for Code Exchange).\n * No client secret is used because CLIs cannot securely store secrets.\n * PKCE provides security through the code_verifier/code_challenge mechanism.\n *\n * For production use, register a public OAuth app with Figma.\n * To register an OAuth app, visit: https://www.figma.com/developers/api#oauth2\n */\nexport const OAUTH_CONFIG: OAuthConfig = {\n  // OAuth client ID (public client)\n  // Uses staging client ID by default since we use staging endpoints\n  clientId: process.env.FIGMA_CLIENT_ID || FIGMA_CLIENT_IDS.staging,\n\n  // No client secret - this is a public OAuth client using PKCE\n  // Public clients cannot securely store secrets in CLI environments\n\n  redirectUri:\n    process.env.FIGMA_REDIRECT_URI || `http://localhost:${DEFAULT_CALLBACK_PORT}/callback`,\n\n  // Only current_user:read scope is needed for basic user info\n  scopes: ['current_user:read'],\n\n  // TODO: Dynamically choose between prod and staging based on environment\n  ...URLS.staging,\n}\n\n/**\n * Buffer time (in seconds) before token expiration to consider token as expired\n * This helps avoid using tokens that are about to expire\n */\nexport const TOKEN_EXPIRY_BUFFER_SECONDS = 300 // 5 minutes\n"],"names":["FIGMA_CLIENT_IDS","DEFAULT_CALLBACK_PORT","URLS","prod","authorizationUrl","refreshUrl","tokenUrl","staging","process","env","FIGMA_AUTH_URL","FIGMA_API_URL","OAUTH_CONFIG","clientId","FIGMA_CLIENT_ID","redirectUri","FIGMA_REDIRECT_URI","scopes","TOKEN_EXPIRY_BUFFER_SECONDS"],"mappings":"AAEA,SAASA,gBAAgB,QAAQ,kBAAiB;AAElD;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,MAAK;AAE1C,OAAO,MAAMC,OAGT;IACFC,MAAM;QACJC,kBAAkB;QAClBC,YAAY;QACZC,UAAU;IACZ;IACAC,SAAS;QACPH,kBAAkBI,QAAQC,GAAG,CAACC,cAAc,GACxC,GAAGF,QAAQC,GAAG,CAACC,cAAc,CAAC,MAAM,CAAC,CAAC,4DAA4D;WAClG;QACJL,YAAYG,QAAQC,GAAG,CAACE,aAAa,GACjC,GAAGH,QAAQC,GAAG,CAACE,aAAa,CAAC,iBAAiB,CAAC,GAC/C;QACJL,UAAUE,QAAQC,GAAG,CAACE,aAAa,GAC/B,GAAGH,QAAQC,GAAG,CAACE,aAAa,CAAC,eAAe,CAAC,GAC7C;IACN;AACF,EAAC;AAED;;;;;;;;;CASC,GACD,OAAO,MAAMC,eAA4B;IACvC,kCAAkC;IAClC,mEAAmE;IACnEC,UAAUL,QAAQC,GAAG,CAACK,eAAe,IAAId,iBAAiBO,OAAO;IAEjE,8DAA8D;IAC9D,mEAAmE;IAEnEQ,aACEP,QAAQC,GAAG,CAACO,kBAAkB,IAAI,CAAC,iBAAiB,EAAEf,sBAAsB,SAAS,CAAC;IAExF,6DAA6D;IAC7DgB,QAAQ;QAAC;KAAoB;IAE7B,yEAAyE;IACzE,GAAGf,KAAKK,OAAO;AACjB,EAAC;AAED;;;CAGC,GACD,OAAO,MAAMW,8BAA8B,IAAI,YAAY;CAAb"}

package/dist/db-content-api/README.md

@@ -0,0 +1,108 @@
+# Content API Database Adapter Parity
+
+This document explains how the Content API database adapter differs from Payload today and how it will behave once alignment is complete.
+
+The Content API is an internal service built exclusively for Payload. Because of that, the adapter should match Payload by default and only diverge when there is a strong technical reason.
+
+## Where
+
+Now  
+`{ path: "slug", operator: "equals", value: "hello", type: "text" }`
+
+Future  
+`{ path: "slug", operator: "equals", value: "hello", type: "text" }`
+
+The format stays different. This allows the Content API to evolve its filter schema, for example to support composite types like Point, which are not lexicographically sortable. Semantics must remain identical to Payload.
+
+## Sorting
+
+Now  
+`[{ path: "createdAt", direction: "desc" }]`
+
+Future  
+`"-createdAt"` or `"createdAt"` or `["-createdAt", "title"]`
+
+Sorting will match Payload. It can be a single string or an array of strings using Payload path syntax.
+
+## Pagination
+
+~~Now~~  
+~~`{ limit: 10, offset: 20 }`~~
+
+✅ Partially Implemented  
+`{ limit: 10, page: 3 }`
+
+**Status:**
+
+- ✅ Content API main endpoints use `page` (matches Payload)
+
+- ⚠️ **Issue #1 (Joins):** `JoinClause` still uses `offset` instead of `page`
+  - Payload `JoinQuery`: `{ page?: number, limit?: number }`
+  - Content API `JoinClause`: `{ offset?: number, limit?: number }`
+  - **Inconsistent** with main endpoints which use `page`
+
+**Current workaround for joins:** The adapter converts `page` to `offset`:
+
+```typescript
+// Payload join query
+{ page: 2, limit: 5 }
+// Adapter converts to offset for Content API
+{ offset: 5, limit: 5 }
+```
+
+**Future:**
+
+1. Content API should support `skip` parameter for main endpoints
+2. Content API `JoinClause` should use `page` instead of `offset` (consistent with main endpoints)
+3. Content API pagination response should match Payload's flat structure
+
+### Pagination Response Structure
+
+**Payload format (flat):**
+
+```typescript
+{
+  docs: [...],
+  hasNextPage: boolean,
+  hasPrevPage: boolean,
+  limit: number,
+  nextPage: number | null,
+  page: number,
+  pagingCounter: number,
+  prevPage: number | null,
+  totalDocs: number,
+  totalPages: number
+}
+```
+
+**Content API format (nested):**
+
+```typescript
+{
+  data: [...],
+  pagination: {
+    total: number,
+    current: { limit: number, page: number },
+    next?: { limit: number, page: number },
+    prev?: { limit: number, page: number }
+  }
+}
+```
+
+**Current workaround:** The adapter transforms Content API's nested structure to Payload's flat structure using `getPaginationData()` utility.
+
+## Slugs
+
+Now  
+`{ collection: { key: "posts" } }`
+
+Future  
+`{ collection: { slug: "posts" } }`
+
+Collection identifiers will match Payload. Consumers should not be aware of internal collection IDs.
+
+## Temporary Conversions
+
+Helpers that translate Payload queries into the current Content API format are temporary and placed in the `temp-utilities` folder.
+
+They live in the `temp-utilities` folder until the Content API is fully aligned with Payload.