@mesheshq/events 1.0.4 → 1.0.5

package/README.md

@@ -231,7 +231,7 @@ This client uses `fetch`. Ensure your runtime provides a global `fetch`:
 
 MIT
 
-[npm-install-size-image]: https://badgen.net/packagephobia/publish/@mesheshq/events?cache=250
+[npm-install-size-image]: https://badgen.net/packagephobia/publish/@mesheshq/events?cache=250&v1.0.5
 [npm-install-size-url]: https://packagephobia.com/result?p=%40mesheshq%2Fevents
 [npm-url]: https://www.npmjs.com/package/@mesheshq/events
-[npm-version-image]: https://badgen.net/npm/v/@mesheshq/events?cache=250
+[npm-version-image]: https://badgen.net/npm/v/@mesheshq/events?cache=250&v1.0.5

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-export default MeshesEventsClient;
-import MeshesEventsClient from "./client.js";
-import { MeshesApiError } from "./client.js";
-export { MeshesEventsClient, MeshesApiError };
+export { MeshesEventsClient, MeshesApiError } from "./client.js";
+export { default } from "./client.js";
+export type { MeshesEvent, MeshesErrorResponse, CreateEventResponseSingle, BulkCreateEventsResult, CallbackFunction, Headers, QueryParams, MeshesOptions, MeshesOptionalRequestOptions, MeshesRequestOptions, MeshesEventPayload, MeshesEventBody, } from "./types.js";

package/dist/lib/errors.d.ts

@@ -3,7 +3,7 @@
  * @extends {Error} - Error class
  * @param {string} message - Error message
  * @param {unknown} data - Additional error data
- * @type {import("../index.js").MeshesApiError} - Meshes API Error
+ * @class - Meshes API Error
  */
 export class MeshesApiError extends Error {
     /**
@@ -11,7 +11,7 @@ export class MeshesApiError extends Error {
      * @param {unknown} [data]
      */
     constructor(message: string | undefined, data?: unknown);
-    data: any;
+    data: unknown;
     /**
      * Convert error to JSON
      * @param {boolean} stack - Include stack trace

package/dist/types.d.ts

@@ -0,0 +1,187 @@
+/**
+ * Typescript type definitions for Meshes Events API
+ * @module meshes-events-client
+ * @license MIT
+ * @since 1.0.0
+ * @description Meshes events client for emitting events with a publishable key.
+ * @repository https://github.com/mesheshq/node-meshes-events-client
+ */
+export type MeshesEvent = {
+    type: "event";
+    event: string;
+    id: string;
+    workspace: string;
+    created_by: string;
+    created_at: string;
+    resource: string;
+    resource_id?: string;
+};
+export type MeshesErrorResponse = {
+    message: string;
+    error?: unknown;
+};
+export type CreateEventResponseSingle = {
+    event: MeshesEvent;
+};
+export type BulkCreateEventsResult = {
+    count: number;
+    records: (MeshesEvent | MeshesErrorResponse)[];
+    error_count?: number;
+};
+/**
+ * Callback function to use rather than promises
+ */
+export type CallbackFunction<T = unknown> = (err: MeshesApiError | null, data?: T) => void;
+/**
+ * Request headers
+ */
+export type Headers = {
+    [key: string]: string;
+};
+/**
+ * Query parameters
+ */
+export type QueryParams = Record<string, string | number | boolean>;
+/**
+ * Meshes API Config Options
+ */
+export type MeshesOptions = {
+    /**
+     * API version
+     */
+    version?: "v1";
+    /**
+     * Request timeout in milliseconds
+     * @constraint [1000-30000]
+     */
+    timeout?: number;
+    /**
+     * Additional request headers
+     */
+    headers?: Headers;
+    /**
+     * If true, will enable debug mode.
+     */
+    debug?: boolean;
+    /**
+     * API Base Url.  This is optional and can be useful for testing.
+     * @default "https://api.meshes.io/api/v1"
+     */
+    apiBaseUrl?: string;
+};
+/**
+ * Meshes API Optional Request Options
+ */
+export type MeshesOptionalRequestOptions = {
+    /**
+     * Request headers
+     */
+    headers?: Headers;
+    /**
+     * Query parameters
+     */
+    query?: QueryParams;
+    /**
+     * Request timeout in milliseconds
+     */
+    timeout?: number;
+};
+/**
+ * Meshes API Request Options
+ */
+export type MeshesRequestOptions = {
+    method: "POST";
+    path: string;
+    body?: unknown;
+    /**
+     * Request headers
+     */
+    headers?: Headers;
+    /**
+     * Query parameters
+     */
+    query?: QueryParams;
+    /**
+     * Request timeout in milliseconds
+     */
+    timeout?: number;
+};
+/**
+ * Meshes event payload structure.
+ */
+export type MeshesEventPayload = {
+    /**
+     * The payload email.  This is required.
+     */
+    email: string;
+    first_name?: string;
+    id?: string;
+    ip_address?: string;
+    last_name?: string;
+    name?: string;
+    phone?: string;
+    resource_url?: string;
+} & {
+    [k: string]: unknown;
+};
+/**
+ * Meshes event structure.
+ */
+export type MeshesEventBody = {
+    /**
+     * The event type for the event.
+     */
+    event: string;
+    /**
+     * The custom resource.  Defaults to 'global'.
+     */
+    resource?: string;
+    /**
+     * The resource ID for a custom resource.
+     */
+    resource_id?: string;
+    /**
+     * The event payload that will be used.
+     */
+    payload: MeshesEventPayload;
+};
+/**
+ * Meshes Events API Client
+ * @class
+ * @property {Function} emit - Create (emit) a single event
+ * @property {Function} emitBatch - Create (emit) multiple events up to 100 at a time
+ */
+export declare class MeshesEventsClient {
+    constructor(publishableKey: string, options?: MeshesOptions);
+    /**
+     * Create (emit) a single event
+     * @param {MeshesEventBody} event - The event to emit
+     * @param {MeshesOptionalRequestOptions} options - Optional request options
+     * @param {CallbackFunction<CreateEventResponseSingle>} done - Optional callback function
+     * @returns {Promise<CreateEventResponseSingle> | undefined} - Request promise or undefined if a callback is provided
+     */
+    emit(event: MeshesEventBody, options?: MeshesOptionalRequestOptions, done?: CallbackFunction<CreateEventResponseSingle>): Promise<CreateEventResponseSingle> | undefined;
+    /**
+     * Create (emit) multiple events up to 100 at a time
+     * @param {MeshesEventBody[]} events - The events to emit
+     * @param {MeshesOptionalRequestOptions} options - Optional request options
+     * @param {CallbackFunction<BulkCreateEventsResult>} done - Optional callback function
+     * @returns {Promise<any> | undefined} - Request promise or undefined if a callback is provided
+     */
+    emitBatch(events: MeshesEventBody[], options?: MeshesOptionalRequestOptions, done?: CallbackFunction<BulkCreateEventsResult>): Promise<BulkCreateEventsResult> | undefined;
+}
+/**
+ * Meshes API Error
+ */
+export declare class MeshesApiError extends Error {
+    data?: any;
+    constructor(message: string, data?: any);
+    toJSON(includeStack?: boolean): {
+        name: string;
+        message: string;
+        data?: any;
+        stack?: any;
+    };
+}
+declare const _default: typeof MeshesEventsClient;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mesheshq/events",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Meshes events client for emitting events with a publishable key.",
   "author": "Todd Schlomer <todd@meshes.io> (https://meshes.io)",
   "license": "MIT",