perspectapi-ts-sdk 6.0.2 → 6.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perspectapi-ts-sdk",
-  "version": "6.0.2",
+  "version": "6.1.0",
   "description": "TypeScript SDK for PerspectAPI - Cloudflare Workers compatible",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -10,11 +10,13 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist/**/*",
     "src/**/*",
+    "tsconfig.json",
     "README.md"
   ],
   "scripts": {

package/src/deprecation.ts

@@ -0,0 +1,24 @@
+/**
+ * v1 deprecation constants — kept in sync with the backend's
+ * `src/lib/deprecation.ts`.
+ *
+ * v1 sunsets 2026-06-01. All new integrations must use the v2 client.
+ */
+
+export const V1_SUNSET_DATE = "2026-06-01";
+export const V1_DEPRECATION_NOTICE =
+  "perspectapi-ts-sdk v1 client is deprecated; sunsets 2026-06-01. " +
+  "New integrations must use createPerspectApiV2Client.";
+
+let warned = false;
+
+/**
+ * Emit the v1 deprecation warning at most once per process. Called from v1
+ * client constructors so anyone instantiating a v1 client sees it.
+ */
+export function warnV1Deprecated(): void {
+  if (warned) return;
+  warned = true;
+  // eslint-disable-next-line no-console
+  console.warn(`[perspectapi-ts-sdk] ${V1_DEPRECATION_NOTICE}`);
+}

package/src/index.ts

@@ -1,31 +1,56 @@
 /**
  * PerspectAPI TypeScript SDK
  * Cloudflare Workers compatible SDK for PerspectAPI
+ *
+ * ⚠️ v1 clients (everything exported from `./perspect-api-client` and
+ * `./client/*`) are deprecated and sunset on 2026-06-01. New integrations
+ * must use `PerspectApiV2Client` / `createPerspectApiV2Client`. See
+ * `src/deprecation.ts` for the shared sunset constants.
  */
 
-// Main client (v1)
-export { PerspectApiClient, createPerspectApiClient } from './perspect-api-client';
-export { default } from './perspect-api-client';
+export { V1_SUNSET_DATE, V1_DEPRECATION_NOTICE } from './deprecation';
 
-// v2 client
+// ───────────────────────────────────────────────────────────────────────────
+// v2 client (current — use for all new integrations)
+// ───────────────────────────────────────────────────────────────────────────
 export { PerspectApiV2Client, createPerspectApiV2Client } from './v2';
 export { PerspectV2Error } from './v2/client/base-v2-client';
 export type * from './v2/types';
 
-// Individual clients (for advanced usage)
+// ───────────────────────────────────────────────────────────────────────────
+// v1 client — DEPRECATED, sunsets 2026-06-01. Do not use for new code.
+// ───────────────────────────────────────────────────────────────────────────
+/** @deprecated v1 — sunsets 2026-06-01. Use PerspectApiV2Client. */
+export { PerspectApiClient, createPerspectApiClient } from './perspect-api-client';
+export { default } from './perspect-api-client';
+
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { AuthClient } from './client/auth-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { ContentClient } from './client/content-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { ApiKeysClient } from './client/api-keys-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { OrganizationsClient } from './client/organizations-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { SitesClient } from './client/sites-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { ProductsClient } from './client/products-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { CategoriesClient } from './client/categories-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { WebhooksClient } from './client/webhooks-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { CheckoutClient } from './client/checkout-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { ContactClient } from './client/contact-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { NewsletterClient } from './client/newsletter-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { NewsletterManagementClient } from './client/newsletter-management-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { SiteUsersClient } from './client/site-users-client';
+/** @deprecated v1 — sunsets 2026-06-01. Use v2 client. */
 export { BundlesClient } from './client/bundles-client';
 
 // Base classes

package/src/perspect-api-client.ts

@@ -19,9 +19,15 @@ import { NewsletterClient } from './client/newsletter-client';
 import { NewsletterManagementClient } from './client/newsletter-management-client';
 import { SiteUsersClient } from './client/site-users-client';
 import { BundlesClient } from './client/bundles-client';
+import { warnV1Deprecated } from './deprecation';
 
 import type { PerspectApiConfig, ApiResponse } from './types';
 
+/**
+ * @deprecated v1 client is deprecated and sunsets 2026-06-01. New
+ * integrations must use `PerspectApiV2Client` / `createPerspectApiV2Client`
+ * from `perspectapi-ts-sdk` (see the `v2-client` reference page).
+ */
 export class PerspectApiClient {
   private http: HttpClient;
   public readonly cache: CacheManager;
@@ -43,6 +49,8 @@ export class PerspectApiClient {
   public readonly bundles: BundlesClient;
 
   constructor(config: PerspectApiConfig) {
+    warnV1Deprecated();
+
     // Validate required configuration
     if (!config.baseUrl) {
       throw new Error('baseUrl is required in PerspectApiConfig');
@@ -182,7 +190,10 @@ export class PerspectApiClient {
 }
 
 /**
- * Create a new PerspectAPI client instance
+ * Create a new PerspectAPI client instance.
+ *
+ * @deprecated v1 factory is deprecated and sunsets 2026-06-01. Use
+ * `createPerspectApiV2Client` for new integrations.
  */
 export function createPerspectApiClient(config: PerspectApiConfig): PerspectApiClient {
   return new PerspectApiClient(config);

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022", "DOM"],
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/*.test.ts",
+    "**/*.spec.ts"
+  ]
+}