@customyai/customy-sdk 0.1.0 → 0.3.2

package/dist/server.d.cts

@@ -0,0 +1,165 @@
+import { CustomyPlatformConfiguration, MachineTokenProvider } from '@customyai/customy-access/server';
+import { CustomySend } from '@customyai/send-sdk';
+import { CustomyLinks } from '@customyai/links-sdk';
+import { k as CustomySdkKey, e as CustomyProductClient } from './portfolio-Bk9cn8h4.cjs';
+
+type CustomerDataEventType = "track" | "identify" | "group" | "page" | "screen" | "alias";
+interface CustomerDataEvent {
+    messageId?: string;
+    type: CustomerDataEventType;
+    event?: string;
+    userId?: string;
+    anonymousId?: string;
+    groupId?: string;
+    timestamp?: string | Date;
+    schemaVersion?: string;
+    properties?: Record<string, unknown>;
+    traits?: Record<string, unknown>;
+    context?: Record<string, unknown>;
+    consent?: Record<string, unknown>;
+}
+interface CustomerDataClientConfig {
+    collectUrl: string;
+    /** Write key de la fuente (navegador y apps sin identidad de servidor). */
+    writeKey?: string;
+    /**
+     * En servidor, en lugar del write key: un token de máquina de Customy Access
+     * con audiencia `customy-data` y scope `data:collect` (la identidad única de
+     * la app; `createMachineTokenProvider` de `@customyai/customy-access/server`).
+     * Data resuelve la fuente de la app a partir de los claims firmados.
+     */
+    accessToken?: () => Promise<string>;
+    fetchImpl?: typeof fetch;
+    maxRetries?: number;
+    retryBaseMs?: number;
+    timeoutMs?: number;
+    maxBatchSize?: number;
+    maxQueueSize?: number;
+    redactFields?: string[];
+    beforeSend?: (event: CustomerDataEvent) => CustomerDataEvent | null;
+    now?: () => Date;
+    idFactory?: () => string;
+    onError?: (error: Error, events: CustomerDataEvent[]) => void;
+}
+interface CustomerDataBatchResponse {
+    accepted: number;
+    deduplicated: number;
+    quarantined: number;
+    results: Array<Record<string, unknown>>;
+}
+/**
+ * Public/browser-safe customer data client. Tenant scope is derived from the
+ * source write key by customy-data; callers cannot select organization,
+ * project or environment in the payload.
+ */
+declare class CustomyCustomerDataClient {
+    private readonly config;
+    private readonly fetchImpl;
+    private readonly maxRetries;
+    private readonly retryBaseMs;
+    private readonly timeoutMs;
+    private readonly maxBatchSize;
+    private readonly maxQueueSize;
+    private readonly redactFields;
+    private readonly now;
+    private readonly idFactory;
+    private queue;
+    private flushing;
+    private inFlightCount;
+    constructor(config: CustomerDataClientConfig);
+    event(input: CustomerDataEvent): CustomerDataEvent;
+    enqueue(input: CustomerDataEvent): number;
+    send(input: CustomerDataEvent): Promise<Record<string, unknown>>;
+    track(event: string, properties: Record<string, unknown>, identity: Pick<CustomerDataEvent, "userId" | "anonymousId" | "groupId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    identify(traits: Record<string, unknown>, identity: Pick<CustomerDataEvent, "userId" | "anonymousId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    group(traits: Record<string, unknown>, identity: Pick<CustomerDataEvent, "groupId" | "userId" | "anonymousId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    page(properties: Record<string, unknown>, identity: Pick<CustomerDataEvent, "userId" | "anonymousId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    screen(properties: Record<string, unknown>, identity: Pick<CustomerDataEvent, "userId" | "anonymousId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    alias(userId: string, previousId: string, options?: Pick<CustomerDataEvent, "context" | "consent">): Promise<Record<string, unknown>>;
+    flush(): Promise<CustomerDataBatchResponse>;
+    private request;
+}
+
+/**
+ * Consumo de una app en Customy Billing con su identidad de Customy Access
+ * (`POST /v1/apps/usage`). El token de máquina, con audiencia `customy-billing`
+ * y scope `billing:usage:report`, fija la organización y la app: el cuerpo solo
+ * lleva el meter, la cantidad y una clave de idempotencia por evento.
+ */
+type AppUsageEvent = {
+    /** Meter declarado por la app, p. ej. `coach.runs`. */
+    meter: string;
+    quantity: number;
+    /** Única por evento: reintentar con la misma clave no suma dos veces. */
+    idempotencyKey: string;
+    occurredAt?: string | Date;
+};
+type AppUsageResult = {
+    accepted: number;
+    events: Array<{
+        meter: string;
+        idempotencyKey: string;
+        id: string;
+        deduplicated: boolean;
+    }>;
+};
+type AppUsageClientConfig = {
+    /** URL de Billing del entorno (discovery: `products.billing.base_url`). */
+    baseUrl: string;
+    /** Proveedor de tokens de Access (`createMachineTokenProvider` de `@customyai/customy-access/server`). */
+    accessToken: () => Promise<string>;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+};
+declare class AppUsageClient {
+    private readonly config;
+    private readonly baseUrl;
+    private readonly fetchImpl;
+    private readonly timeoutMs;
+    constructor(config: AppUsageClientConfig);
+    /** Reporta hasta 100 eventos de consumo en una llamada. */
+    report(events: AppUsageEvent[]): Promise<AppUsageResult>;
+}
+
+/**
+ * @customyai/customy-sdk/server — `createCustomy()`: una sola identidad de app para todo el ecosistema.
+ *
+ * @deprecated Usa `createCustomy` de `@customyai/sdk`: misma forma
+ * (`{ issuer, clientId, clientSecret }`, `token`, `product`), con los clientes
+ * de los paquetes nuevos. Este módulo es su adaptador durante un ciclo major:
+ * el discovery y los tokens de máquina son los de `@customyai/sdk` (y
+ * `@customyai/core`); `send`, `links`, `data` y `billing` conservan las clases
+ * de 0.x.
+ *
+ *   const customy = await createCustomy({ issuer, clientId, clientSecret });
+ *   await customy.send.emails.send({ ... });
+ *   await customy.billing.report([{ meter: "coach.runs", quantity: 1, idempotencyKey }]);
+ *   await customy.product("crm").get("/v1/contacts");
+ */
+
+type CreateCustomyOptions = {
+    /** Issuer de Customy Access del entorno, p. ej. `https://access-api.customy.ai`. */
+    issuer: string;
+    clientId: string;
+    clientSecret: string;
+    /** Scopes por producto (clave del discovery). Sin entrada, los del cliente. */
+    scopes?: Partial<Record<string, readonly string[]>>;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+    /** Opciones extra del cliente de Data (colas, redacción, `onError`…). */
+    data?: Omit<CustomerDataClientConfig, "collectUrl" | "writeKey" | "accessToken" | "fetchImpl">;
+};
+type Customy = {
+    readonly platform: CustomyPlatformConfiguration;
+    /** Proveedor de tokens de máquina para la audiencia de un producto del discovery. */
+    token(product: string): MachineTokenProvider;
+    /** Cliente HTTP genérico de un producto, con su URL y su proveedor de tokens. */
+    product(product: CustomySdkKey): CustomyProductClient;
+    readonly send: CustomySend;
+    readonly links: CustomyLinks;
+    readonly data: CustomyCustomerDataClient;
+    readonly billing: AppUsageClient;
+};
+declare function createCustomy(options: CreateCustomyOptions): Promise<Customy>;
+
+export { type CreateCustomyOptions, type Customy, createCustomy };

package/dist/server.d.ts

@@ -0,0 +1,165 @@
+import { CustomyPlatformConfiguration, MachineTokenProvider } from '@customyai/customy-access/server';
+import { CustomySend } from '@customyai/send-sdk';
+import { CustomyLinks } from '@customyai/links-sdk';
+import { k as CustomySdkKey, e as CustomyProductClient } from './portfolio-Bk9cn8h4.js';
+
+type CustomerDataEventType = "track" | "identify" | "group" | "page" | "screen" | "alias";
+interface CustomerDataEvent {
+    messageId?: string;
+    type: CustomerDataEventType;
+    event?: string;
+    userId?: string;
+    anonymousId?: string;
+    groupId?: string;
+    timestamp?: string | Date;
+    schemaVersion?: string;
+    properties?: Record<string, unknown>;
+    traits?: Record<string, unknown>;
+    context?: Record<string, unknown>;
+    consent?: Record<string, unknown>;
+}
+interface CustomerDataClientConfig {
+    collectUrl: string;
+    /** Write key de la fuente (navegador y apps sin identidad de servidor). */
+    writeKey?: string;
+    /**
+     * En servidor, en lugar del write key: un token de máquina de Customy Access
+     * con audiencia `customy-data` y scope `data:collect` (la identidad única de
+     * la app; `createMachineTokenProvider` de `@customyai/customy-access/server`).
+     * Data resuelve la fuente de la app a partir de los claims firmados.
+     */
+    accessToken?: () => Promise<string>;
+    fetchImpl?: typeof fetch;
+    maxRetries?: number;
+    retryBaseMs?: number;
+    timeoutMs?: number;
+    maxBatchSize?: number;
+    maxQueueSize?: number;
+    redactFields?: string[];
+    beforeSend?: (event: CustomerDataEvent) => CustomerDataEvent | null;
+    now?: () => Date;
+    idFactory?: () => string;
+    onError?: (error: Error, events: CustomerDataEvent[]) => void;
+}
+interface CustomerDataBatchResponse {
+    accepted: number;
+    deduplicated: number;
+    quarantined: number;
+    results: Array<Record<string, unknown>>;
+}
+/**
+ * Public/browser-safe customer data client. Tenant scope is derived from the
+ * source write key by customy-data; callers cannot select organization,
+ * project or environment in the payload.
+ */
+declare class CustomyCustomerDataClient {
+    private readonly config;
+    private readonly fetchImpl;
+    private readonly maxRetries;
+    private readonly retryBaseMs;
+    private readonly timeoutMs;
+    private readonly maxBatchSize;
+    private readonly maxQueueSize;
+    private readonly redactFields;
+    private readonly now;
+    private readonly idFactory;
+    private queue;
+    private flushing;
+    private inFlightCount;
+    constructor(config: CustomerDataClientConfig);
+    event(input: CustomerDataEvent): CustomerDataEvent;
+    enqueue(input: CustomerDataEvent): number;
+    send(input: CustomerDataEvent): Promise<Record<string, unknown>>;
+    track(event: string, properties: Record<string, unknown>, identity: Pick<CustomerDataEvent, "userId" | "anonymousId" | "groupId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    identify(traits: Record<string, unknown>, identity: Pick<CustomerDataEvent, "userId" | "anonymousId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    group(traits: Record<string, unknown>, identity: Pick<CustomerDataEvent, "groupId" | "userId" | "anonymousId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    page(properties: Record<string, unknown>, identity: Pick<CustomerDataEvent, "userId" | "anonymousId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    screen(properties: Record<string, unknown>, identity: Pick<CustomerDataEvent, "userId" | "anonymousId" | "context" | "consent">): Promise<Record<string, unknown>>;
+    alias(userId: string, previousId: string, options?: Pick<CustomerDataEvent, "context" | "consent">): Promise<Record<string, unknown>>;
+    flush(): Promise<CustomerDataBatchResponse>;
+    private request;
+}
+
+/**
+ * Consumo de una app en Customy Billing con su identidad de Customy Access
+ * (`POST /v1/apps/usage`). El token de máquina, con audiencia `customy-billing`
+ * y scope `billing:usage:report`, fija la organización y la app: el cuerpo solo
+ * lleva el meter, la cantidad y una clave de idempotencia por evento.
+ */
+type AppUsageEvent = {
+    /** Meter declarado por la app, p. ej. `coach.runs`. */
+    meter: string;
+    quantity: number;
+    /** Única por evento: reintentar con la misma clave no suma dos veces. */
+    idempotencyKey: string;
+    occurredAt?: string | Date;
+};
+type AppUsageResult = {
+    accepted: number;
+    events: Array<{
+        meter: string;
+        idempotencyKey: string;
+        id: string;
+        deduplicated: boolean;
+    }>;
+};
+type AppUsageClientConfig = {
+    /** URL de Billing del entorno (discovery: `products.billing.base_url`). */
+    baseUrl: string;
+    /** Proveedor de tokens de Access (`createMachineTokenProvider` de `@customyai/customy-access/server`). */
+    accessToken: () => Promise<string>;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+};
+declare class AppUsageClient {
+    private readonly config;
+    private readonly baseUrl;
+    private readonly fetchImpl;
+    private readonly timeoutMs;
+    constructor(config: AppUsageClientConfig);
+    /** Reporta hasta 100 eventos de consumo en una llamada. */
+    report(events: AppUsageEvent[]): Promise<AppUsageResult>;
+}
+
+/**
+ * @customyai/customy-sdk/server — `createCustomy()`: una sola identidad de app para todo el ecosistema.
+ *
+ * @deprecated Usa `createCustomy` de `@customyai/sdk`: misma forma
+ * (`{ issuer, clientId, clientSecret }`, `token`, `product`), con los clientes
+ * de los paquetes nuevos. Este módulo es su adaptador durante un ciclo major:
+ * el discovery y los tokens de máquina son los de `@customyai/sdk` (y
+ * `@customyai/core`); `send`, `links`, `data` y `billing` conservan las clases
+ * de 0.x.
+ *
+ *   const customy = await createCustomy({ issuer, clientId, clientSecret });
+ *   await customy.send.emails.send({ ... });
+ *   await customy.billing.report([{ meter: "coach.runs", quantity: 1, idempotencyKey }]);
+ *   await customy.product("crm").get("/v1/contacts");
+ */
+
+type CreateCustomyOptions = {
+    /** Issuer de Customy Access del entorno, p. ej. `https://access-api.customy.ai`. */
+    issuer: string;
+    clientId: string;
+    clientSecret: string;
+    /** Scopes por producto (clave del discovery). Sin entrada, los del cliente. */
+    scopes?: Partial<Record<string, readonly string[]>>;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+    /** Opciones extra del cliente de Data (colas, redacción, `onError`…). */
+    data?: Omit<CustomerDataClientConfig, "collectUrl" | "writeKey" | "accessToken" | "fetchImpl">;
+};
+type Customy = {
+    readonly platform: CustomyPlatformConfiguration;
+    /** Proveedor de tokens de máquina para la audiencia de un producto del discovery. */
+    token(product: string): MachineTokenProvider;
+    /** Cliente HTTP genérico de un producto, con su URL y su proveedor de tokens. */
+    product(product: CustomySdkKey): CustomyProductClient;
+    readonly send: CustomySend;
+    readonly links: CustomyLinks;
+    readonly data: CustomyCustomerDataClient;
+    readonly billing: AppUsageClient;
+};
+declare function createCustomy(options: CreateCustomyOptions): Promise<Customy>;
+
+export { type CreateCustomyOptions, type Customy, createCustomy };