activitysmith 0.1.1 → 0.1.3

package/README.md

@@ -1,6 +1,6 @@
-# ActivitySmith Node.js Library
+# ActivitySmith Node SDK
 
-The ActivitySmith Node library provides convenient access to the ActivitySmith API from server-side JavaScript and TypeScript applications.
+The ActivitySmith Node SDK provides convenient access to the ActivitySmith API from server-side JavaScript and TypeScript applications.
 
 ## Documentation
 
@@ -12,50 +12,106 @@ See [API reference](https://activitysmith.com/docs/api-reference/introduction)
 npm install activitysmith
 ```
 
-## Usage
-
-ESM:
+## Setup
 
 ```ts
 import ActivitySmith from "activitysmith";
 
-const client = new ActivitySmith({
+const activitysmith = new ActivitySmith({
   apiKey: process.env.ACTIVITYSMITH_API_KEY,
 });
+```
 
-// Push Notifications
-await client.notifications.sendPushNotification({
-  pushNotificationRequest: {
-    // See PushNotificationRequest for fields
-  },
+CommonJS:
+
+```js
+const ActivitySmith = require("activitysmith");
+
+const activitysmith = new ActivitySmith({
+  apiKey: process.env.ACTIVITYSMITH_API_KEY,
 });
+```
+
+## Usage
+
+### Send a Push Notification
+
+```ts
+const response = await activitysmith.notifications.send({
+  title: "Build Failed",
+  message: "CI pipeline failed on main branch",
+  channels: ["devs", "ops"], // Optional
+});
+
+console.log(response.success);
+console.log(response.devices_notified);
+```
+
+### Start a Live Activity
 
-// Live Activities
-await client.liveActivities.startLiveActivity({
-  liveActivityStartRequest: {
-    // See LiveActivityStartRequest for fields
+```ts
+const start = await activitysmith.liveActivities.start({
+  content_state: {
+    title: "ActivitySmith API Deployment",
+    subtitle: "start",
+    number_of_steps: 4,
+    current_step: 1,
+    type: "segmented_progress",
+    color: "yellow",
   },
+  channels: ["devs", "ops"], // Optional
 });
+
+const activityId = start.activity_id;
 ```
 
-CommonJS:
+### Update a Live Activity
 
-```js
-const ActivitySmith = require("activitysmith");
+```ts
+const update = await activitysmith.liveActivities.update({
+  activity_id: activityId,
+  content_state: {
+    title: "ActivitySmith API Deployment",
+    subtitle: "npm i & pm2",
+    current_step: 3,
+  },
+});
 
-const client = new ActivitySmith({
-  apiKey: process.env.ACTIVITYSMITH_API_KEY,
+console.log(update.devices_notified);
+```
+
+### End a Live Activity
+
+```ts
+const end = await activitysmith.liveActivities.end({
+  activity_id: activityId,
+  content_state: {
+    title: "ActivitySmith API Deployment",
+    subtitle: "done",
+    current_step: 4,
+    auto_dismiss_minutes: 3,
+  },
 });
+
+console.log(end.success);
 ```
 
-## API Surface
+## Error Handling
 
-The client exposes grouped resources:
+```ts
+try {
+  await activitysmith.notifications.send({
+    title: "Build Failed",
+  });
+} catch (error) {
+  console.error(error);
+}
+```
 
-- `client.liveActivities`
-- `client.notifications`
+## API Surface
 
-Each method is fully typed. Request and response types are included in the type definitions.
+- `activitysmith.notifications`
+- `activitysmith.liveActivities`
 
 ## TypeScript Support
 

package/dist/generated/apis/LiveActivitiesApi.d.ts

@@ -35,12 +35,12 @@ export declare class LiveActivitiesApi extends runtime.BaseAPI {
      */
     endLiveActivity(requestParameters: EndLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LiveActivityEndResponse>;
     /**
-     * Starts a Live Activity on all registered devices and returns an activity_id.
+     * Starts a Live Activity on devices matched by API key scope and optional target channels.
      * Start a Live Activity
      */
     startLiveActivityRaw(requestParameters: StartLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LiveActivityStartResponse>>;
     /**
-     * Starts a Live Activity on all registered devices and returns an activity_id.
+     * Starts a Live Activity on devices matched by API key scope and optional target channels.
      * Start a Live Activity
      */
     startLiveActivity(requestParameters: StartLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LiveActivityStartResponse>;

package/dist/generated/apis/LiveActivitiesApi.js

@@ -55,7 +55,7 @@ class LiveActivitiesApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Starts a Live Activity on all registered devices and returns an activity_id.
+     * Starts a Live Activity on devices matched by API key scope and optional target channels.
      * Start a Live Activity
      */
     async startLiveActivityRaw(requestParameters, initOverrides) {
@@ -82,7 +82,7 @@ class LiveActivitiesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Starts a Live Activity on all registered devices and returns an activity_id.
+     * Starts a Live Activity on devices matched by API key scope and optional target channels.
      * Start a Live Activity
      */
     async startLiveActivity(requestParameters, initOverrides) {

package/dist/generated/apis/PushNotificationsApi.d.ts

@@ -19,12 +19,12 @@ export interface SendPushNotificationRequest {
  */
 export declare class PushNotificationsApi extends runtime.BaseAPI {
     /**
-     * Sends a push notification to every paired device in your account.
+     * Sends a push notification to devices matched by API key scope and optional target channels.
      * Send a push notification
      */
     sendPushNotificationRaw(requestParameters: SendPushNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PushNotificationResponse>>;
     /**
-     * Sends a push notification to every paired device in your account.
+     * Sends a push notification to devices matched by API key scope and optional target channels.
      * Send a push notification
      */
     sendPushNotification(requestParameters: SendPushNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PushNotificationResponse>;

package/dist/generated/apis/PushNotificationsApi.js

@@ -20,7 +20,7 @@ const runtime = require("../runtime");
  */
 class PushNotificationsApi extends runtime.BaseAPI {
     /**
-     * Sends a push notification to every paired device in your account.
+     * Sends a push notification to devices matched by API key scope and optional target channels.
      * Send a push notification
      */
     async sendPushNotificationRaw(requestParameters, initOverrides) {
@@ -47,7 +47,7 @@ class PushNotificationsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Sends a push notification to every paired device in your account.
+     * Sends a push notification to devices matched by API key scope and optional target channels.
      * Send a push notification
      */
     async sendPushNotification(requestParameters, initOverrides) {

package/dist/generated/models/index.d.ts

@@ -1,9 +1,64 @@
+/**
+ *
+ * @export
+ * @interface AlertPayload
+ */
+export interface AlertPayload {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof AlertPayload
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AlertPayload
+     */
+    body?: string;
+}
+/**
+ *
+ * @export
+ * @interface BadRequestError
+ */
+export interface BadRequestError {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof BadRequestError
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BadRequestError
+     */
+    message: string;
+}
+/**
+ *
+ * @export
+ * @interface ChannelTarget
+ */
+export interface ChannelTarget {
+    [key: string]: any | any;
+    /**
+     * Channel slugs. When omitted, API key scope determines recipients.
+     * @type {Array<string>}
+     * @memberof ChannelTarget
+     */
+    channels: Array<string>;
+}
 /**
  * End payload. Required fields are title and current_step. number_of_steps is optional.
  * @export
  * @interface ContentStateEnd
  */
 export interface ContentStateEnd {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -83,6 +138,7 @@ export type ContentStateEndStepColorEnum = typeof ContentStateEndStepColorEnum[k
  * @interface ContentStateStart
  */
 export interface ContentStateStart {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -169,6 +225,7 @@ export type ContentStateStartStepColorEnum = typeof ContentStateStartStepColorEn
  * @interface ContentStateUpdate
  */
 export interface ContentStateUpdate {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -236,12 +293,33 @@ export declare const ContentStateUpdateStepColorEnum: {
     readonly Yellow: "yellow";
 };
 export type ContentStateUpdateStepColorEnum = typeof ContentStateUpdateStepColorEnum[keyof typeof ContentStateUpdateStepColorEnum];
+/**
+ *
+ * @export
+ * @interface ForbiddenError
+ */
+export interface ForbiddenError {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof ForbiddenError
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ForbiddenError
+     */
+    message: string;
+}
 /**
  *
  * @export
  * @interface LiveActivityEndRequest
  */
 export interface LiveActivityEndRequest {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -261,6 +339,7 @@ export interface LiveActivityEndRequest {
  * @interface LiveActivityEndResponse
  */
 export interface LiveActivityEndResponse {
+    [key: string]: any | any;
     /**
      *
      * @type {boolean}
@@ -298,6 +377,7 @@ export interface LiveActivityEndResponse {
  * @interface LiveActivityLimitError
  */
 export interface LiveActivityLimitError {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -329,12 +409,25 @@ export interface LiveActivityLimitError {
  * @interface LiveActivityStartRequest
  */
 export interface LiveActivityStartRequest {
+    [key: string]: any | any;
     /**
      *
      * @type {ContentStateStart}
      * @memberof LiveActivityStartRequest
      */
     content_state: ContentStateStart;
+    /**
+     *
+     * @type {AlertPayload}
+     * @memberof LiveActivityStartRequest
+     */
+    alert?: AlertPayload;
+    /**
+     *
+     * @type {ChannelTarget}
+     * @memberof LiveActivityStartRequest
+     */
+    target?: ChannelTarget;
 }
 /**
  *
@@ -342,6 +435,7 @@ export interface LiveActivityStartRequest {
  * @interface LiveActivityStartResponse
  */
 export interface LiveActivityStartResponse {
+    [key: string]: any | any;
     /**
      *
      * @type {boolean}
@@ -366,6 +460,12 @@ export interface LiveActivityStartResponse {
      * @memberof LiveActivityStartResponse
      */
     activity_id: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof LiveActivityStartResponse
+     */
+    effective_channel_slugs?: Array<string>;
     /**
      *
      * @type {string}
@@ -379,6 +479,7 @@ export interface LiveActivityStartResponse {
  * @interface LiveActivityUpdateRequest
  */
 export interface LiveActivityUpdateRequest {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -398,6 +499,7 @@ export interface LiveActivityUpdateRequest {
  * @interface LiveActivityUpdateResponse
  */
 export interface LiveActivityUpdateResponse {
+    [key: string]: any | any;
     /**
      *
      * @type {boolean}
@@ -429,12 +531,39 @@ export interface LiveActivityUpdateResponse {
      */
     timestamp: string;
 }
+/**
+ *
+ * @export
+ * @interface NoRecipientsError
+ */
+export interface NoRecipientsError {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof NoRecipientsError
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof NoRecipientsError
+     */
+    message: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof NoRecipientsError
+     */
+    effective_channel_slugs?: Array<string>;
+}
 /**
  *
  * @export
  * @interface PushNotificationRequest
  */
 export interface PushNotificationRequest {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -453,6 +582,32 @@ export interface PushNotificationRequest {
      * @memberof PushNotificationRequest
      */
     subtitle?: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PushNotificationRequest
+     */
+    payload?: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof PushNotificationRequest
+     */
+    badge?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PushNotificationRequest
+     */
+    sound?: string;
+    /**
+     *
+     * @type {ChannelTarget}
+     * @memberof PushNotificationRequest
+     */
+    target?: ChannelTarget;
 }
 /**
  *
@@ -460,6 +615,7 @@ export interface PushNotificationRequest {
  * @interface PushNotificationResponse
  */
 export interface PushNotificationResponse {
+    [key: string]: any | any;
     /**
      *
      * @type {boolean}
@@ -478,6 +634,12 @@ export interface PushNotificationResponse {
      * @memberof PushNotificationResponse
      */
     users_notified?: number;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof PushNotificationResponse
+     */
+    effective_channel_slugs?: Array<string>;
     /**
      *
      * @type {string}
@@ -491,6 +653,7 @@ export interface PushNotificationResponse {
  * @interface RateLimitError
  */
 export interface RateLimitError {
+    [key: string]: any | any;
     /**
      *
      * @type {string}

package/dist/src/ActivitySmith.d.ts

@@ -2,8 +2,41 @@ import { PushNotificationsApi, LiveActivitiesApi } from "../generated/index";
 export interface ActivitySmithOptions {
     apiKey: string;
 }
+type PushRequestBody = Parameters<PushNotificationsApi["sendPushNotification"]>[0]["pushNotificationRequest"];
+type SendInitOverrides = Parameters<PushNotificationsApi["sendPushNotification"]>[1];
+type StartRequestBody = Parameters<LiveActivitiesApi["startLiveActivity"]>[0]["liveActivityStartRequest"];
+type UpdateRequestBody = Parameters<LiveActivitiesApi["updateLiveActivity"]>[0]["liveActivityUpdateRequest"];
+type EndRequestBody = Parameters<LiveActivitiesApi["endLiveActivity"]>[0]["liveActivityEndRequest"];
+type LiveInitOverrides = Parameters<LiveActivitiesApi["startLiveActivity"]>[1];
+type PushSendRequest = PushRequestBody & {
+    channels?: string[];
+};
+type LiveStartSendRequest = StartRequestBody & {
+    channels?: string[];
+};
+export declare class NotificationsResource {
+    private readonly api;
+    constructor(api: PushNotificationsApi);
+    send(request: PushSendRequest, initOverrides?: SendInitOverrides): Promise<import("../generated/models").PushNotificationResponse>;
+    sendPushNotification(...args: Parameters<PushNotificationsApi["sendPushNotification"]>): Promise<import("../generated/models").PushNotificationResponse>;
+    sendPushNotificationRaw(...args: Parameters<PushNotificationsApi["sendPushNotificationRaw"]>): Promise<import("../generated/runtime").ApiResponse<import("../generated/models").PushNotificationResponse>>;
+}
+export declare class LiveActivitiesResource {
+    private readonly api;
+    constructor(api: LiveActivitiesApi);
+    start(request: LiveStartSendRequest, initOverrides?: LiveInitOverrides): Promise<import("../generated/models").LiveActivityStartResponse>;
+    update(request: UpdateRequestBody, initOverrides?: LiveInitOverrides): Promise<import("../generated/models").LiveActivityUpdateResponse>;
+    end(request: EndRequestBody, initOverrides?: LiveInitOverrides): Promise<import("../generated/models").LiveActivityEndResponse>;
+    startLiveActivity(...args: Parameters<LiveActivitiesApi["startLiveActivity"]>): Promise<import("../generated/models").LiveActivityStartResponse>;
+    updateLiveActivity(...args: Parameters<LiveActivitiesApi["updateLiveActivity"]>): Promise<import("../generated/models").LiveActivityUpdateResponse>;
+    endLiveActivity(...args: Parameters<LiveActivitiesApi["endLiveActivity"]>): Promise<import("../generated/models").LiveActivityEndResponse>;
+    startLiveActivityRaw(...args: Parameters<LiveActivitiesApi["startLiveActivityRaw"]>): Promise<import("../generated/runtime").ApiResponse<import("../generated/models").LiveActivityStartResponse>>;
+    updateLiveActivityRaw(...args: Parameters<LiveActivitiesApi["updateLiveActivityRaw"]>): Promise<import("../generated/runtime").ApiResponse<import("../generated/models").LiveActivityUpdateResponse>>;
+    endLiveActivityRaw(...args: Parameters<LiveActivitiesApi["endLiveActivityRaw"]>): Promise<import("../generated/runtime").ApiResponse<import("../generated/models").LiveActivityEndResponse>>;
+}
 export declare class ActivitySmith {
-    readonly notifications: PushNotificationsApi;
-    readonly liveActivities: LiveActivitiesApi;
+    readonly notifications: NotificationsResource;
+    readonly liveActivities: LiveActivitiesResource;
     constructor(opts: ActivitySmithOptions);
 }
+export {};

package/dist/src/ActivitySmith.js

@@ -1,7 +1,69 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActivitySmith = void 0;
+exports.ActivitySmith = exports.LiveActivitiesResource = exports.NotificationsResource = void 0;
 const index_1 = require("../generated/index");
+function withTargetChannels(request) {
+    const channels = request.channels;
+    if (!channels || channels.length === 0 || request.target) {
+        const { channels: _ignored, ...rest } = request;
+        return rest;
+    }
+    const { channels: _ignored, ...rest } = request;
+    return {
+        ...rest,
+        target: { channels },
+    };
+}
+class NotificationsResource {
+    constructor(api) {
+        this.api = api;
+    }
+    send(request, initOverrides) {
+        return this.api.sendPushNotification({ pushNotificationRequest: withTargetChannels(request) }, initOverrides);
+    }
+    // Backward-compatible alias.
+    sendPushNotification(...args) {
+        return this.api.sendPushNotification(...args);
+    }
+    sendPushNotificationRaw(...args) {
+        return this.api.sendPushNotificationRaw(...args);
+    }
+}
+exports.NotificationsResource = NotificationsResource;
+class LiveActivitiesResource {
+    constructor(api) {
+        this.api = api;
+    }
+    start(request, initOverrides) {
+        return this.api.startLiveActivity({ liveActivityStartRequest: withTargetChannels(request) }, initOverrides);
+    }
+    update(request, initOverrides) {
+        return this.api.updateLiveActivity({ liveActivityUpdateRequest: request }, initOverrides);
+    }
+    end(request, initOverrides) {
+        return this.api.endLiveActivity({ liveActivityEndRequest: request }, initOverrides);
+    }
+    // Backward-compatible aliases.
+    startLiveActivity(...args) {
+        return this.api.startLiveActivity(...args);
+    }
+    updateLiveActivity(...args) {
+        return this.api.updateLiveActivity(...args);
+    }
+    endLiveActivity(...args) {
+        return this.api.endLiveActivity(...args);
+    }
+    startLiveActivityRaw(...args) {
+        return this.api.startLiveActivityRaw(...args);
+    }
+    updateLiveActivityRaw(...args) {
+        return this.api.updateLiveActivityRaw(...args);
+    }
+    endLiveActivityRaw(...args) {
+        return this.api.endLiveActivityRaw(...args);
+    }
+}
+exports.LiveActivitiesResource = LiveActivitiesResource;
 class ActivitySmith {
     constructor(opts) {
         if (!opts?.apiKey) {
@@ -11,8 +73,8 @@ class ActivitySmith {
         const config = new index_1.Configuration({
             accessToken: opts.apiKey,
         });
-        this.notifications = new index_1.PushNotificationsApi(config);
-        this.liveActivities = new index_1.LiveActivitiesApi(config);
+        this.notifications = new NotificationsResource(new index_1.PushNotificationsApi(config));
+        this.liveActivities = new LiveActivitiesResource(new index_1.LiveActivitiesApi(config));
     }
 }
 exports.ActivitySmith = ActivitySmith;

package/package.json

@@ -1,14 +1,30 @@
 {
   "name": "activitysmith",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Official ActivitySmith Node.js SDK",
   "keywords": [
     "activitysmith",
-    "live activities",
-    "push notifications",
-    "api"
+    "live-activities",
+    "push-notifications",
+    "api",
+    "sdk",
+    "deployment",
+    "publishing",
+    "monitoring",
+    "observability",
+    "logging",
+    "logs",
+    "automation",
+    "tracking",
+    "reporting"
   ],
-  "homepage": "https://github.com/ActivitySmithHQ/activitysmith-node",
+  "author": "ActivitySmith",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ActivitySmithHQ/activitysmith-node.git"
+  },
+  "homepage": "https://activitysmith.com/docs/sdks/node",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "exports": {
@@ -24,7 +40,6 @@
     "README.md",
     "LICENSE"
   ],
-  "license": "MIT",
   "engines": {
     "node": ">=18"
   },