activitysmith 0.1.1 → 0.1.2

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,104 @@ 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",
+});
+
+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",
   },
 });
+
+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/src/ActivitySmith.d.ts

@@ -2,8 +2,35 @@ 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];
+export declare class NotificationsResource {
+    private readonly api;
+    constructor(api: PushNotificationsApi);
+    send(request: PushRequestBody, 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: StartRequestBody, 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,57 @@
 "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");
+class NotificationsResource {
+    constructor(api) {
+        this.api = api;
+    }
+    send(request, initOverrides) {
+        return this.api.sendPushNotification({ pushNotificationRequest: 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: 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 +61,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.2",
   "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"
   },