@schematichq/schematic-typescript-node 1.4.1 → 1.4.3

package/README.md

@@ -601,6 +601,97 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
 }
 ```
 
+## DataStream
+
+DataStream enables local flag evaluation by maintaining a WebSocket connection to Schematic and caching flag rules, company, and user data locally.
+
+> **Runtime compatibility:** DataStream requires Node.js APIs (`WebSocket`, `EventEmitter`) and is not supported in edge runtimes such as Cloudflare Workers, Vercel Edge Functions, or Deno Deploy. For these runtimes, use [Replicator Mode](#replicator-mode) instead.
+
+### Setup
+
+```ts
+import { SchematicClient } from "@schematichq/schematic-typescript-node";
+
+const client = new SchematicClient({
+    apiKey: process.env.SCHEMATIC_API_KEY,
+    useDataStream: true,
+});
+
+// Flag checks are now evaluated locally
+const flagValue = await client.checkFlag(
+    { company: { id: "your-company-id" } },
+    "some-flag-key",
+);
+
+client.close();
+```
+
+### Configuration options
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `cacheTTL` | `number` | 24 hours | Cache TTL in milliseconds |
+| `redisClient` | `RedisClient` | — | Redis client for shared caching (uses in-memory cache if not provided) |
+| `redisKeyPrefix` | `string` | `schematic:` | Key prefix for Redis cache entries |
+
+```ts
+import { createClient } from "redis";
+import { SchematicClient } from "@schematichq/schematic-typescript-node";
+
+const redisClient = createClient({ url: "redis://localhost:6379" });
+await redisClient.connect();
+
+const client = new SchematicClient({
+    apiKey: process.env.SCHEMATIC_API_KEY,
+    useDataStream: true,
+    dataStream: {
+        redisClient,
+        redisKeyPrefix: "schematic:",
+        cacheTTL: 60 * 60 * 1000, // 1 hour
+    },
+});
+```
+
+## Replicator Mode
+
+Replicator mode is designed for environments where a separate process (the replicator) manages the WebSocket connection and populates a shared cache. The SDK reads from that cache and evaluates flags locally without establishing its own WebSocket connection.
+
+### Requirements
+
+Replicator mode requires a shared cache (Redis or custom cache providers) so the SDK can read data written by the external replicator process.
+
+### Setup
+
+```ts
+import { createClient } from "redis";
+import { SchematicClient } from "@schematichq/schematic-typescript-node";
+
+const redisClient = createClient({ url: "redis://localhost:6379" });
+await redisClient.connect();
+
+const client = new SchematicClient({
+    apiKey: process.env.SCHEMATIC_API_KEY,
+    useDataStream: true,
+    dataStream: {
+        replicatorMode: true,
+        redisClient,
+        replicatorHealthURL: "http://localhost:8080/health",
+        replicatorHealthCheck: 30000, // 30 seconds
+    },
+});
+```
+
+### Configuration options
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `replicatorMode` | `boolean` | `false` | Enable replicator mode |
+| `redisClient` | `RedisClient` | — | **Required.** Redis client for reading from the shared cache |
+| `redisKeyPrefix` | `string` | `schematic:` | Key prefix for Redis cache entries |
+| `replicatorHealthURL` | `string` | — | URL to poll for replicator health status |
+| `replicatorHealthCheck` | `number` | 30000 | Health check polling interval in milliseconds |
+| `cacheTTL` | `number` | 24 hours | Cache TTL in milliseconds |
+
 ## Testing
 
 ### Offline mode

package/dist/api/resources/billing/client/Client.d.ts

@@ -369,7 +369,6 @@ export declare class BillingClient {
      * @example
      *     await client.billing.upsertBillingProduct({
      *         externalId: "external_id",
-     *         name: "name",
      *         price: 1.1
      *     })
      */

package/dist/api/resources/billing/client/requests/CreateBillingProductRequestBody.d.ts

@@ -3,14 +3,13 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         externalId: "external_id",
- *         name: "name",
  *         price: 1.1
  *     }
  */
 export interface CreateBillingProductRequestBody {
     externalId: string;
     isActive?: boolean;
-    name: string;
+    name?: string;
     price: number;
     providerType?: Schematic.BillingProviderType;
 }

package/dist/api/resources/plangroups/client/Client.d.ts

@@ -11,6 +11,7 @@ export declare class PlangroupsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PlangroupsClient.Options>;
     constructor(options: PlangroupsClient.Options);
     /**
+     * @param {Schematic.GetPlanGroupRequest} request
      * @param {PlangroupsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.UnauthorizedError}
@@ -19,9 +20,11 @@ export declare class PlangroupsClient {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.plangroups.getPlanGroup()
+     *     await client.plangroups.getPlanGroup({
+     *         includeCompanyCounts: true
+     *     })
      */
-    getPlanGroup(requestOptions?: PlangroupsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanGroupResponse>;
+    getPlanGroup(request?: Schematic.GetPlanGroupRequest, requestOptions?: PlangroupsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanGroupResponse>;
     private __getPlanGroup;
     /**
      * @param {Schematic.CreatePlanGroupRequestBody} request

package/dist/api/resources/plangroups/client/requests/GetPlanGroupRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         includeCompanyCounts: true
+ *     }
+ */
+export interface GetPlanGroupRequest {
+    includeCompanyCounts?: boolean;
+}

package/dist/api/resources/plangroups/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export type { CreatePlanGroupRequestBody } from "./CreatePlanGroupRequestBody";
+export type { GetPlanGroupRequest } from "./GetPlanGroupRequest";
 export type { UpdatePlanGroupRequestBody } from "./UpdatePlanGroupRequestBody";

package/dist/api/resources/plangroups/types/GetPlanGroupParams.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Input parameters
+ */
+export interface GetPlanGroupParams {
+    includeCompanyCounts?: boolean;
+}

package/dist/api/resources/plangroups/types/GetPlanGroupResponse.d.ts

@@ -2,5 +2,5 @@ import type * as Schematic from "../../../index";
 export interface GetPlanGroupResponse {
     data: Schematic.PlanGroupDetailResponseData;
     /** Input parameters */
-    params: Record<string, unknown>;
+    params: Schematic.GetPlanGroupParams;
 }

package/dist/api/resources/plangroups/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./CreatePlanGroupResponse";
+export * from "./GetPlanGroupParams";
 export * from "./GetPlanGroupResponse";
 export * from "./UpdatePlanGroupResponse";

package/dist/api/types/BillingCreditBundleResponseData.d.ts

@@ -1,6 +1,5 @@
 import type * as Schematic from "../index";
 export interface BillingCreditBundleResponseData {
-    billingInvoiceId?: string;
     bundleType: Schematic.BillingCreditBundleType;
     createdAt: Date;
     creditDescription?: string;

package/dist/api/types/BillingCreditBundleView.d.ts

@@ -1,6 +1,5 @@
 import type * as Schematic from "../index";
 export interface BillingCreditBundleView {
-    billingInvoiceId?: string;
     bundleType: Schematic.BillingCreditBundleType;
     createdAt: Date;
     creditDescription?: string;

package/dist/api/types/CaptureRawEvent.d.ts

@@ -0,0 +1,7 @@
+export interface CaptureRawEvent {
+    capturedAt: Date;
+    eventId?: string;
+    rawBytes: number[];
+    remoteIp: string;
+    userAgent: string;
+}

package/dist/api/types/CaptureRawEventBatch.d.ts

@@ -0,0 +1,4 @@
+import type * as Schematic from "../index";
+export interface CaptureRawEventBatch {
+    events: Schematic.CaptureRawEvent[];
+}

package/dist/api/types/CheckFlagsResponseData.d.ts

@@ -1,4 +1,5 @@
 import type * as Schematic from "../index";
 export interface CheckFlagsResponseData {
     flags: Schematic.CheckFlagResponseData[];
+    plan?: Schematic.DatastreamCompanyPlan;
 }

package/dist/api/types/DatastreamCompanyPlan.d.ts

@@ -0,0 +1,5 @@
+export interface DatastreamCompanyPlan {
+    id: string;
+    name: string;
+    trialEndDate?: Date;
+}

package/dist/api/types/PlanChangeResponseData.d.ts

@@ -9,12 +9,16 @@ export interface PlanChangeResponseData {
     basePlan?: Schematic.PlanSnapshotView;
     /** Any special behavior that affected the assignment of the base plan during this change. */
     basePlanAction?: Schematic.PlanChangeBasePlanAction;
+    /** The plan version that was assigned during this change. */
+    basePlanVersion?: Schematic.PlanVersionSnapshotView;
     company?: Schematic.CompanyResponseData;
     companyId: string;
     createdAt: Date;
     environmentId: string;
     id: string;
     previousBasePlan?: Schematic.PlanSnapshotView;
+    /** The plan version of the previous base plan before this change. */
+    previousBasePlanVersion?: Schematic.PlanVersionSnapshotView;
     requestId?: string;
     /** If a subscription was changed as a part of this plan change, indicates the type of change that was made. */
     subscriptionChangeAction?: Schematic.PlanChangeSubscriptionAction;

package/dist/api/types/PlanVersionSnapshotView.d.ts

@@ -0,0 +1,5 @@
+export interface PlanVersionSnapshotView {
+    id: string;
+    name: string;
+    version: number;
+}

package/dist/api/types/WhoAmIResponseData.d.ts

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface WhoAmIResponseData {
     accountId: string;
     accountName: string;
-    actorType: string;
+    actorType: Schematic.ActorType;
     apiKeyId?: string;
     environmentId?: string;
     environments: Schematic.EnvironmentResponseData[];

package/dist/api/types/index.d.ts

@@ -47,6 +47,8 @@ export * from "./BillingSubscriptionResponseData";
 export * from "./BillingSubscriptionTrialEndSetting";
 export * from "./BillingSubscriptionView";
 export * from "./BillingTiersMode";
+export * from "./CaptureRawEvent";
+export * from "./CaptureRawEventBatch";
 export * from "./ChangeSubscriptionInternalRequestBody";
 export * from "./ChangeSubscriptionRequestBody";
 export * from "./ChargeType";
@@ -138,6 +140,7 @@ export * from "./DataExportOutputFileType";
 export * from "./DataExportResponseData";
 export * from "./DataExportStatus";
 export * from "./DataExportType";
+export * from "./DatastreamCompanyPlan";
 export * from "./DeleteBillingPlanCreditGrantRequestBody";
 export * from "./DeleteResponse";
 export * from "./DuplicatePlanEntitlementsResponseResponseData";
@@ -230,6 +233,7 @@ export * from "./PlanVersionMigrationResponseData";
 export * from "./PlanVersionMigrationStatus";
 export * from "./PlanVersionMigrationStrategy";
 export * from "./PlanVersionResponseData";
+export * from "./PlanVersionSnapshotView";
 export * from "./PlanVersionStatus";
 export * from "./PlanViewPublicResponseData";
 export * from "./PreviewObject";