@nurama/sdk 0.0.0-stage → 1.4.0

package/src/routes/settings.ts

@@ -0,0 +1,152 @@
+import NuramaClient from '../NuramaClient.js';
+
+export interface ResourceSettingsOverrides {
+  emailNotifications?: {
+    sendEmailNotifications?: boolean | null;
+    newMention?: boolean | null;
+    newFollowing?: boolean | null;
+    dailySummary?: boolean | null;
+    publishedAsset?: boolean | null;
+    newMentionActiveInterval?: number | null;
+    newFollowingActiveInterval?: number | null;
+  };
+  systemNotifications?: {
+    showSystemNotifications?: boolean | null;
+    mentions?: boolean | null;
+    alerts?: boolean | null;
+    privateMessages?: boolean | null;
+  };
+  sounds?: {
+    playSounds?: boolean | null;
+    mentions?: boolean | null;
+    alerts?: boolean | null;
+    privateMessages?: boolean | null;
+  };
+}
+
+export interface ResourceSettings {
+  resourceId: string;
+  resourceType: 'workspace' | 'project';
+  emailNotifications?: Record<string, any>;
+  systemNotifications?: Record<string, any>;
+  sounds?: Record<string, any>;
+}
+
+export interface EffectiveSettings {
+  emailNotifications: Record<string, any>;
+  systemNotifications: Record<string, any>;
+  sounds: Record<string, any>;
+}
+
+/**
+ * Defines settings-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the settings-related methods.
+ */
+export default function createSettingsMethods(client: NuramaClient) {
+  return {
+    /**
+     * Get effective (resolved) settings for a resource with full cascade.
+     * Requires authentication.
+     * @param {string} resourceType - The resource type (workspace or project).
+     * @param {string} resourceId - The resource ID.
+     * @param {string} [workspaceId] - The workspace ID (required for projects).
+     * @returns {Promise<EffectiveSettings>} The effective settings object.
+     */
+    async getEffectiveSettings(
+      resourceType: 'workspace' | 'project',
+      resourceId: string,
+      workspaceId?: string,
+    ): Promise<EffectiveSettings> {
+      return client._request({
+        method: 'GET',
+        endpoint: `/v1/settings/${resourceType}/${resourceId}/effective`,
+        params: workspaceId ? { workspaceId } : undefined,
+        sendJWT: true,
+      });
+    },
+
+    /**
+     * Get raw resource settings (overrides only, not cascaded).
+     * Requires authentication.
+     * @param {string} resourceType - The resource type (workspace or project).
+     * @param {string} resourceId - The resource ID.
+     * @returns {Promise<ResourceSettings | { message: string }>} The resource settings object.
+     */
+    async getResourceSettings(
+      resourceType: 'workspace' | 'project',
+      resourceId: string,
+    ): Promise<ResourceSettings | { message: string }> {
+      return client._request({
+        method: 'GET',
+        endpoint: `/v1/settings/${resourceType}/${resourceId}`,
+        sendJWT: true,
+      });
+    },
+
+    /**
+     * Get all resource settings for current user.
+     * Requires authentication.
+     * @returns {Promise<{ resourceSettings: ResourceSettings[] }>} Object containing array of resource settings.
+     */
+    async getAllResourceSettings(): Promise<{ resourceSettings: ResourceSettings[] }> {
+      return client._request({
+        method: 'GET',
+        endpoint: '/v1/settings',
+        sendJWT: true,
+      });
+    },
+
+    /**
+     * Update resource-specific settings.
+     * Requires authentication.
+     * @param {string} resourceType - The resource type (workspace or project).
+     * @param {string} resourceId - The resource ID.
+     * @param {ResourceSettingsOverrides} settings - The settings to update.
+     * @returns {Promise<{ message: string; settings: ResourceSettings }>} Success message and updated settings.
+     */
+    async updateResourceSettings(
+      resourceType: 'workspace' | 'project',
+      resourceId: string,
+      settings: ResourceSettingsOverrides,
+    ): Promise<{ message: string; settings: ResourceSettings }> {
+      return client._request({
+        method: 'PUT',
+        endpoint: `/v1/settings/${resourceType}/${resourceId}`,
+        body: settings,
+        sendJWT: true,
+      });
+    },
+
+    /**
+     * Reset resource settings to inherit from parent/global.
+     * Requires authentication.
+     * @param {string} resourceType - The resource type (workspace or project).
+     * @param {string} resourceId - The resource ID.
+     * @returns {Promise<{ message: string }>} Success message.
+     */
+    async resetResourceSettings(
+      resourceType: 'workspace' | 'project',
+      resourceId: string,
+    ): Promise<{ message: string }> {
+      return client._request({
+        method: 'DELETE',
+        endpoint: `/v1/settings/${resourceType}/${resourceId}`,
+        sendJWT: true,
+      });
+    },
+
+    /**
+     * Cleanup orphaned settings (settings for resources user no longer has access to).
+     * Requires authentication.
+     * @returns {Promise<{ message: string; removedCount: number }>} Success message and count of removed settings.
+     */
+    async cleanupOrphanedSettings(): Promise<{ message: string; removedCount: number }> {
+      return client._request({
+        method: 'POST',
+        endpoint: '/v1/settings/cleanup',
+        sendJWT: true,
+      });
+    },
+  };
+}

package/src/routes/shortlink.ts

@@ -0,0 +1,90 @@
+import NuramaClient from '../NuramaClient.js';
+
+// --- Response Interfaces ---
+export interface ResolveShortLinkResponse {
+  deepLink: string;
+  resourceId: string;
+  resourceType: 'asset' | 'project' | 'workspace' | 'chatMessage' | 'chatSubmission';
+  visibility: 'creator' | 'reviewer' | null;
+}
+
+export interface ResolvePublicDownloadResponse {
+  token: string;
+  fileName: string;
+  mediaType: string;
+  status: string;
+  /**
+   * Capability mode of the link. The download page uses this to decide
+   * whether to render the inline preview (`embed-download`), the embed-only
+   * message (`embed`), or auto-download (`download`). Optional for backward
+   * compatibility with older API versions; treat absence as `embed-download`.
+   */
+  mode?: 'download' | 'embed' | 'embed-download';
+  /** Mime type of the original media file, when known. */
+  mimeType?: string | null;
+  /**
+   * For image assets: the keyPath of the image file, used to render an
+   * inline preview on the download page. Null for non-image assets (video /
+   * audio previews are iframed from the embed page; files render an icon).
+   */
+  previewKeyPath?: string | null;
+}
+
+export interface PublicDownloadUrlResponse {
+  url: string;
+  fileName: string;
+  mimeType: string;
+  expires: number;
+}
+
+export interface PublicEmbedFilesResponse {
+  fileName: string;
+  mediaType: 'video' | 'audio' | 'image' | 'file' | string;
+  /**
+   * Mode of the underlying public link: 'embed' (no download) or 'embed-download'
+   * (download allowed alongside embed). 'download' never appears — that mode
+   * blocks the embed-files endpoint entirely. Optional for backward compatibility
+   * with older API versions; treat absence as 'embed-download'.
+   */
+  mode?: 'embed' | 'embed-download';
+  /** HLS manifest keyPath (e.g. "workspaces/.../stream/index.m3u8"), null if not yet processed. */
+  streamKeyPath: string | null;
+  /** Original media keyPath used as fallback when no HLS manifest is available. */
+  mediaKeyPath: string | null;
+  /** Poster image keyPath for video assets (explicit poster, falling back to largest thumbnail). Null when none exists. */
+  posterKeyPath: string | null;
+  /** Pre-computed waveform peaks JSON keyPath for audio assets. Null for video / when no peaks file exists. */
+  waveformKeyPath?: string | null;
+  /**
+   * Timeline-thumbnail geometry (`asset.meta.storyboard`) for a video's filmstrip and
+   * hover preview. Null for non-video assets or video without storyboard sheets.
+   * Optional for backward compatibility with older API versions.
+   */
+  storyboard?: Record<string, unknown> | null;
+  /** The storyboard sheet files matching `storyboard.sheets`. Empty when there's no storyboard. */
+  storyboardFiles?: Array<{ name?: string; keyPath: string }>;
+}
+
+/**
+ * Defines short link related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the short link related methods.
+ */
+export default function createShortLinkMethods(client: NuramaClient) {
+  return {
+    /**
+     * Resolves a short link code to its full deep link path.
+     * This endpoint is publicly accessible and does not require authentication.
+     * @param {string} code - The 8-character alphanumeric short link code.
+     * @returns {Promise<ResolveShortLinkResponse>} The resolved deep link information.
+     */
+    async resolveShortLink(code: string): Promise<ResolveShortLinkResponse> {
+      if (!code) throw new Error('code is required.');
+      return client._request<ResolveShortLinkResponse>({
+        method: 'GET',
+        endpoint: `/v1/shortlink/${code}`,
+        sendJWT: false,
+      });
+    },
+  };
+}