@productcraft/waitlist 0.1.2 → 0.2.1

package/README.md

@@ -40,9 +40,8 @@ If the waitlist has `settings.recaptcha_site_key` set, also pass a `recaptcha_to
 ```ts
 import { Waitlist } from "@productcraft/waitlist";
 
-const waitlist = new Waitlist({
-  auth: { type: "apiKey", key: process.env.PCFT_KEY! },
-});
+// Reads PRODUCTCRAFT_API_KEY from the environment
+const waitlist = new Waitlist();
 
 // Create a waitlist — body uses `display_name`, not `name`.
 const { data } = await waitlist.client.POST(
@@ -56,11 +55,25 @@ const { data } = await waitlist.client.POST(
 
 `{workspace_id}` is the workspace UUID returned by `@productcraft/platform-auth`'s introspect endpoint.
 
+## Credentials from the environment
+
+Server-side, omit `auth` and the client reads your workspace key from the environment:
+
+```bash
+# .env
+PRODUCTCRAFT_API_KEY=pcft_live_...
+```
+
+- An explicit `auth` always wins over the environment.
+- Hosts are never read from the environment. Override them in code with `baseUrl`.
+- This is a server-only fallback. Never put a key in `NEXT_PUBLIC_*` or any other variable a bundler inlines into browser code.
+
 ## Configuration
 
 ```ts
 new Waitlist({
   // Optional: required for workspace-admin calls. Public submit works without auth.
+  // Omit to use PRODUCTCRAFT_API_KEY from the environment
   auth: { type: "apiKey", key: "pcft_live_..." }
       | { type: "bearer", token: "eyJ..." }
       | { type: "cookie", value: "auth_token=..." },

package/dist/index.d.cts

@@ -972,10 +972,16 @@ interface components {
              */
             message: string | string[];
             /**
-             * @description HTTP status code echoed in the body. Spelled `statusCode` (camelCase) in every ProductCraft API.
+             * @deprecated
+             * @description Deprecated alias of `status_code`, same value. Kept so existing clients keep working; read `status_code`. Error responses carry `Deprecation: true` while it is sent.
+             * @example 403
+             */
+            statusCode?: number;
+            /**
+             * @description HTTP status code echoed in the body (`status_code`). `statusCode` carries the same value as a deprecated alias.
              * @example 403
              */
-            statusCode: number;
+            status_code: number;
         };
         InviteToAppDto: {
             /** @description Auth app slug to invite into; defaults to the workspace Waitlist settings default (`default_heimdall_app_slug`) */
@@ -1062,8 +1068,14 @@ interface components {
              * @example https://evil.test
              */
             origin: string;
+            /**
+             * @deprecated
+             * @description Deprecated alias of `status_code`, same value. Kept so existing clients keep working; read `status_code`. Error responses carry `Deprecation: true` while it is sent.
+             * @example 403
+             */
+            statusCode?: number;
             /** @example 403 */
-            statusCode: number;
+            status_code: number;
         };
         PaginationDto: {
             /**
@@ -1853,7 +1865,7 @@ interface operations {
                     "application/json": components["schemas"]["PublicWaitlistInfoDto"];
                 };
             };
-            /** @description Waitlist not found or not active */
+            /** @description Code `WAITLIST_NOT_FOUND`: no such waitlist, not active, or its workspace was deleted. The answer is the same in every case. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -1907,7 +1919,7 @@ interface operations {
                     "application/json": components["schemas"]["OriginNotAllowedErrorDto"];
                 };
             };
-            /** @description Waitlist not found */
+            /** @description Code `WAITLIST_NOT_FOUND`: no such waitlist, or its workspace was deleted. The answer is the same in both cases. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -1969,7 +1981,7 @@ interface operations {
                     "application/json": components["schemas"]["PublicLeaderboardEntryDto"][];
                 };
             };
-            /** @description Waitlist not found or not active */
+            /** @description Code `WAITLIST_NOT_FOUND`: no such waitlist, not active, or its workspace was deleted. The answer is the same in every case. */
             404: {
                 headers: {
                     [name: string]: unknown;

package/dist/index.d.ts

@@ -972,10 +972,16 @@ interface components {
              */
             message: string | string[];
             /**
-             * @description HTTP status code echoed in the body. Spelled `statusCode` (camelCase) in every ProductCraft API.
+             * @deprecated
+             * @description Deprecated alias of `status_code`, same value. Kept so existing clients keep working; read `status_code`. Error responses carry `Deprecation: true` while it is sent.
+             * @example 403
+             */
+            statusCode?: number;
+            /**
+             * @description HTTP status code echoed in the body (`status_code`). `statusCode` carries the same value as a deprecated alias.
              * @example 403
              */
-            statusCode: number;
+            status_code: number;
         };
         InviteToAppDto: {
             /** @description Auth app slug to invite into; defaults to the workspace Waitlist settings default (`default_heimdall_app_slug`) */
@@ -1062,8 +1068,14 @@ interface components {
              * @example https://evil.test
              */
             origin: string;
+            /**
+             * @deprecated
+             * @description Deprecated alias of `status_code`, same value. Kept so existing clients keep working; read `status_code`. Error responses carry `Deprecation: true` while it is sent.
+             * @example 403
+             */
+            statusCode?: number;
             /** @example 403 */
-            statusCode: number;
+            status_code: number;
         };
         PaginationDto: {
             /**
@@ -1853,7 +1865,7 @@ interface operations {
                     "application/json": components["schemas"]["PublicWaitlistInfoDto"];
                 };
             };
-            /** @description Waitlist not found or not active */
+            /** @description Code `WAITLIST_NOT_FOUND`: no such waitlist, not active, or its workspace was deleted. The answer is the same in every case. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -1907,7 +1919,7 @@ interface operations {
                     "application/json": components["schemas"]["OriginNotAllowedErrorDto"];
                 };
             };
-            /** @description Waitlist not found */
+            /** @description Code `WAITLIST_NOT_FOUND`: no such waitlist, or its workspace was deleted. The answer is the same in both cases. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -1969,7 +1981,7 @@ interface operations {
                     "application/json": components["schemas"]["PublicLeaderboardEntryDto"][];
                 };
             };
-            /** @description Waitlist not found or not active */
+            /** @description Code `WAITLIST_NOT_FOUND`: no such waitlist, not active, or its workspace was deleted. The answer is the same in every case. */
             404: {
                 headers: {
                     [name: string]: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@productcraft/waitlist",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "Waitlist management — public-form signups, variants for A/B/n landing pages, referrals, position + leaderboard, approval workflow with invite-to-app, signed outbound webhooks, CSV export. Generated from the production OpenAPI spec.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -43,7 +43,7 @@
   },
   "dependencies": {
     "openapi-fetch": "^0.13.0",
-    "@productcraft/core": "^0.2.1"
+    "@productcraft/core": "^0.3.0"
   },
   "scripts": {
     "build": "tsup"