@notiflows/node 0.0.1

package/src/internal/utils/path.ts

@@ -0,0 +1,88 @@
+import { NotiflowsError } from '../../core/error';
+
+/**
+ * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
+ *
+ * Taken from https://datatracker.ietf.org/doc/html/rfc3986#section-3.3:
+ * > unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
+ * > sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+ * > pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
+ */
+export function encodeURIPath(str: string) {
+  return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
+}
+
+const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
+
+export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
+  function path(statics: readonly string[], ...params: readonly unknown[]): string {
+    // If there are no params, no processing is needed.
+    if (statics.length === 1) return statics[0]!;
+
+    let postPath = false;
+    const invalidSegments = [];
+    const path = statics.reduce((previousValue, currentValue, index) => {
+      if (/[?#]/.test(currentValue)) {
+        postPath = true;
+      }
+      const value = params[index];
+      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
+      if (
+        index !== params.length &&
+        (value == null ||
+          (typeof value === 'object' &&
+            // handle values from other realms
+            value.toString ===
+              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
+                ?.toString))
+      ) {
+        encoded = value + '';
+        invalidSegments.push({
+          start: previousValue.length + currentValue.length,
+          length: encoded.length,
+          error: `Value of type ${Object.prototype.toString
+            .call(value)
+            .slice(8, -1)} is not a valid path parameter`,
+        });
+      }
+      return previousValue + currentValue + (index === params.length ? '' : encoded);
+    }, '');
+
+    const pathOnly = path.split(/[?#]/, 1)[0]!;
+    const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
+    let match;
+
+    // Find all invalid segments
+    while ((match = invalidSegmentPattern.exec(pathOnly)) !== null) {
+      invalidSegments.push({
+        start: match.index,
+        length: match[0].length,
+        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
+      });
+    }
+
+    invalidSegments.sort((a, b) => a.start - b.start);
+
+    if (invalidSegments.length > 0) {
+      let lastEnd = 0;
+      const underline = invalidSegments.reduce((acc, segment) => {
+        const spaces = ' '.repeat(segment.start - lastEnd);
+        const arrows = '^'.repeat(segment.length);
+        lastEnd = segment.start + segment.length;
+        return acc + spaces + arrows;
+      }, '');
+
+      throw new NotiflowsError(
+        `Path parameters result in path with invalid segments:\n${invalidSegments
+          .map((e) => e.error)
+          .join('\n')}\n${path}\n${underline}`,
+      );
+    }
+
+    return path;
+  };
+
+/**
+ * URI-encodes path params and ensures no unsafe /./ or /../ path segments are introduced.
+ */
+export const path = /* @__PURE__ */ createPathTagFunction(encodeURIPath);

package/src/internal/utils/sleep.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export const sleep = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms));

package/src/internal/utils/uuid.ts

@@ -0,0 +1,17 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * https://stackoverflow.com/a/2117523
+ */
+export let uuid4 = function () {
+  const { crypto } = globalThis as any;
+  if (crypto?.randomUUID) {
+    uuid4 = crypto.randomUUID.bind(crypto);
+    return crypto.randomUUID();
+  }
+  const u8 = new Uint8Array(1);
+  const randomByte = crypto ? () => crypto.getRandomValues(u8)[0]! : () => (Math.random() * 0xff) & 0xff;
+  return '10000000-1000-4000-8000-100000000000'.replace(/[018]/g, (c) =>
+    (+c ^ (randomByte() & (15 >> (+c / 4)))).toString(16),
+  );
+};

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { NotiflowsError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new NotiflowsError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new NotiflowsError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new NotiflowsError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new NotiflowsError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new NotiflowsError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/pagination.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/deliveries.ts

@@ -0,0 +1,183 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Deliveries extends APIResource {
+  /**
+   * Retrieve details of a single delivery attempt.
+   *
+   * Includes the rendered content (`data`), channel information, and all timestamp
+   * tracking (sent, seen, read, clicked, archived).
+   *
+   * @example
+   * ```ts
+   * const delivery = await client.deliveries.retrieve(
+   *   '01HQXYZ123456789ABCDEFGHIJ',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Delivery> {
+    return this._client.get(path`/deliveries/${id}`, options);
+  }
+
+  /**
+   * Retrieve a paginated list of all deliveries in your project.
+   *
+   * A delivery represents a single attempt to send a notification through a specific
+   * channel. Use filters to narrow down results by channel, status, or time range.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const delivery of client.deliveries.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: DeliveryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DeliveriesCursorPage, Delivery> {
+    return this._client.getAPIList('/deliveries', CursorPage<Delivery>, { query, ...options });
+  }
+}
+
+export type DeliveriesCursorPage = CursorPage<Delivery>;
+
+/**
+ * A single delivery attempt through a specific channel
+ */
+export interface Delivery {
+  /**
+   * Delivery ID
+   */
+  id: string;
+
+  /**
+   * Type of channel used for this delivery
+   */
+  channel_type: 'in_app' | 'email' | 'sms' | 'chat' | 'web_push' | 'mobile_push';
+
+  /**
+   * When the delivery was created
+   */
+  created_at: string;
+
+  /**
+   * ID of the parent notification
+   */
+  notification_id: string;
+
+  /**
+   * ID of the notiflow
+   */
+  notiflow_id: string;
+
+  /**
+   * Internal ID of the recipient
+   */
+  recipient_id: string;
+
+  /**
+   * Delivery status:
+   *
+   * - `pending`: Queued for sending
+   * - `sent`: Successfully sent to the provider
+   * - `failed`: Delivery failed
+   */
+  status: 'pending' | 'sent' | 'failed';
+
+  /**
+   * When the delivery was last updated
+   */
+  updated_at: string;
+
+  /**
+   * Internal ID of the actor
+   */
+  actor_id?: string | null;
+
+  /**
+   * When the recipient archived it
+   */
+  archived_at?: string | null;
+
+  /**
+   * ID of the channel used for delivery
+   */
+  channel_id?: string | null;
+
+  /**
+   * When the recipient clicked/interacted
+   */
+  clicked_at?: string | null;
+
+  /**
+   * Rendered notification content (varies by channel type)
+   */
+  data?: unknown;
+
+  /**
+   * When the recipient marked it as read
+   */
+  read_at?: string | null;
+
+  /**
+   * When the recipient saw the notification
+   */
+  seen_at?: string | null;
+
+  /**
+   * When the delivery was sent to the provider
+   */
+  sent_at?: string | null;
+
+  /**
+   * Topic name if triggered via topic
+   */
+  topic?: string | null;
+}
+
+export interface DeliveryListParams extends CursorPageParams {
+  /**
+   * Cursor for fetching the previous page
+   */
+  before?: string;
+
+  /**
+   * Filter by channel ID (UUID)
+   */
+  channel_id?: string;
+
+  /**
+   * Filter by created after (ISO 8601 datetime)
+   */
+  created_after?: string;
+
+  /**
+   * Filter by created before (ISO 8601 datetime)
+   */
+  created_before?: string;
+
+  /**
+   * Filter by status (pending, sent, failed)
+   */
+  status?: string;
+
+  /**
+   * Filter by topic name
+   */
+  topic?: string;
+}
+
+export declare namespace Deliveries {
+  export {
+    type Delivery as Delivery,
+    type DeliveriesCursorPage as DeliveriesCursorPage,
+    type DeliveryListParams as DeliveryListParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Deliveries, type Delivery, type DeliveryListParams, type DeliveriesCursorPage } from './deliveries';
+export {
+  Notifications,
+  type Notification,
+  type NotificationListParams,
+  type NotificationListDeliveriesParams,
+  type NotificationsCursorPage,
+} from './notifications';
+export { NotiflowsResource, type NotiflowRunResponse, type NotiflowRunParams } from './notiflows';
+export { Topics, type Topic, type TopicListParams, type TopicsCursorPage } from './topics/topics';
+export {
+  Users,
+  type User,
+  type UserListParams,
+  type UserUpsertParams,
+  type UsersCursorPage,
+} from './users/users';

package/src/resources/notifications.ts

@@ -0,0 +1,225 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as DeliveriesAPI from './deliveries';
+import { DeliveriesCursorPage } from './deliveries';
+import * as UsersAPI from './users/users';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Notifications extends APIResource {
+  /**
+   * Retrieve a single notification by ID, including the recipient, actor, and all
+   * delivery attempts.
+   *
+   * @example
+   * ```ts
+   * const notification = await client.notifications.retrieve(
+   *   '01HQXYZ123456789ABCDEFGHIJ',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Notification> {
+    return this._client.get(path`/notifications/${id}`, options);
+  }
+
+  /**
+   * Retrieve a paginated list of all notifications in your project.
+   *
+   * A notification represents a message sent to a single recipient through a
+   * notiflow run. Each notification can have multiple deliveries (one per channel).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const notification of client.notifications.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: NotificationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<NotificationsCursorPage, Notification> {
+    return this._client.getAPIList('/notifications', CursorPage<Notification>, { query, ...options });
+  }
+
+  /**
+   * Retrieve all delivery attempts for a specific notification.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const delivery of client.notifications.listDeliveries(
+   *   '01HQXYZ123456789ABCDEFGHIJ',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  listDeliveries(
+    notificationID: string,
+    query: NotificationListDeliveriesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DeliveriesCursorPage, DeliveriesAPI.Delivery> {
+    return this._client.getAPIList(
+      path`/notifications/${notificationID}/deliveries`,
+      CursorPage<DeliveriesAPI.Delivery>,
+      { query, ...options },
+    );
+  }
+}
+
+export type NotificationsCursorPage = CursorPage<Notification>;
+
+/**
+ * A notification sent to a recipient through a notiflow run
+ */
+export interface Notification {
+  /**
+   * Notification ID
+   */
+  id: string;
+
+  /**
+   * When the notification was created
+   */
+  created_at: string;
+
+  /**
+   * Template variables passed when running the notiflow
+   */
+  data: unknown;
+
+  /**
+   * ID of the notiflow that generated this notification
+   */
+  notiflow_id: string;
+
+  /**
+   * ID of the specific notiflow run
+   */
+  notiflow_run_id: string;
+
+  /**
+   * Internal ID of the recipient user
+   */
+  recipient_id: string;
+
+  /**
+   * Notification processing status:
+   *
+   * - `pending`: Queued for processing
+   * - `processing`: Currently being processed
+   * - `processed`: Successfully processed (deliveries created)
+   * - `failed`: Processing failed
+   */
+  status: 'pending' | 'processing' | 'processed' | 'failed';
+
+  /**
+   * When the notification was last updated
+   */
+  updated_at: string;
+
+  /**
+   * A user (recipient) in your project
+   */
+  actor?: UsersAPI.User | null;
+
+  /**
+   * Internal ID of the actor (user who triggered the notification)
+   */
+  actor_id?: string | null;
+
+  /**
+   * Delivery attempts for this notification (when expanded)
+   */
+  deliveries?: Array<DeliveriesAPI.Delivery>;
+
+  /**
+   * When the notification was processed
+   */
+  processed_at?: string | null;
+
+  /**
+   * A user (recipient) in your project
+   */
+  recipient?: UsersAPI.User;
+
+  /**
+   * Topic name if triggered via topic
+   */
+  topic?: string | null;
+}
+
+export interface NotificationListParams extends CursorPageParams {
+  /**
+   * Cursor for fetching the previous page
+   */
+  before?: string;
+
+  /**
+   * Filter by created after (ISO 8601 datetime)
+   */
+  created_after?: string;
+
+  /**
+   * Filter by created before (ISO 8601 datetime)
+   */
+  created_before?: string;
+
+  /**
+   * Filter by status
+   */
+  status?: string;
+
+  /**
+   * Filter by topic
+   */
+  topic?: string;
+}
+
+export interface NotificationListDeliveriesParams extends CursorPageParams {
+  /**
+   * Cursor for fetching the previous page
+   */
+  before?: string;
+
+  /**
+   * Filter by channel ID (UUID)
+   */
+  channel_id?: string;
+
+  /**
+   * Filter by created after (ISO 8601 datetime)
+   */
+  created_after?: string;
+
+  /**
+   * Filter by created before (ISO 8601 datetime)
+   */
+  created_before?: string;
+
+  /**
+   * Filter by status (pending, sent, failed)
+   */
+  status?: string;
+
+  /**
+   * Filter by topic name
+   */
+  topic?: string;
+}
+
+export declare namespace Notifications {
+  export {
+    type Notification as Notification,
+    type NotificationsCursorPage as NotificationsCursorPage,
+    type NotificationListParams as NotificationListParams,
+    type NotificationListDeliveriesParams as NotificationListDeliveriesParams,
+  };
+}
+
+export { type DeliveriesCursorPage };