@royalti/syynk 0.1.1 → 0.2.0

package/README.md

@@ -76,8 +76,10 @@ const result = await client.transcribe({
 
 // Result contains:
 // - projectId: string
+// - editorUrl: string (URL to open in Syynk editor)
 // - language: string
 // - duration: number (seconds)
+// - lyricsText: string (plain text lyrics)
 // - segments: Segment[]
 // - words: Word[]
 ```
@@ -148,28 +150,44 @@ const result = await client.listProjects({
 });
 
 // Result contains:
-// - projects: Project[]
+// - projects: ProjectSummary[]
 // - total: number
-// - hasMore: boolean
+// - limit: number
+// - offset: number
 ```
 
 #### `getProject(id, options?)`
 
-Get a single project with segments and words.
+Get a single project with segments and optionally words.
 
 ```typescript
-const project = await client.getProject('project-id', {
-  includeWords: true,
-  includeSegments: true,
+const result = await client.getProject('project-id', {
+  includeWords: true, // default: true
 });
+
+// Result contains:
+// - project: Project (id, name, type, status, editorUrl, audioUrl, etc.)
+// - segments: Segment[]
+// - words?: Word[] (if includeWords is true)
+```
+
+#### `getLyrics(id)`
+
+Get plain text lyrics for a project.
+
+```typescript
+const result = await client.getLyrics('project-id');
+console.log(result.lyrics);
+// "First line of lyrics\nSecond line\n..."
 ```
 
 #### `deleteProject(id)`
 
-Delete a project.
+Delete a project and all its segments and words.
 
 ```typescript
 await client.deleteProject('project-id');
+console.log('Project deleted');
 ```
 
 #### `getRateLimitInfo()`
@@ -257,6 +275,9 @@ import type {
   Segment,
   Word,
   Project,
+  ProjectSummary,
+  ProjectResult,
+  LyricsResult,
   ExportFormat,
   TranscribeResult,
   ExportResult,

package/dist/index.d.mts

@@ -45,10 +45,14 @@ interface TranscribeFileOptions {
 interface TranscribeResult {
     /** Unique identifier for the created project */
     projectId: string;
+    /** URL to open the project in the Syynk editor */
+    editorUrl: string;
     /** Detected or specified language code */
     language: string;
     /** Audio duration in seconds */
     duration: number;
+    /** Plain text lyrics (segments joined by newlines) */
+    lyricsText: string;
     /** Transcribed segments with line-level timestamps */
     segments: Segment[];
     /** Individual words with word-level timestamps */
@@ -73,6 +77,10 @@ interface Segment {
     speakerId?: string | null;
     /** Transcription confidence score (0-1) */
     confidence?: number | null;
+    /** ISO 8601 creation timestamp (included in project detail responses) */
+    createdAt?: string;
+    /** ISO 8601 last update timestamp (included in project detail responses) */
+    updatedAt?: string;
 }
 /**
  * A word with precise timestamp within a segment
@@ -92,6 +100,8 @@ interface Word {
     sortOrder: number;
     /** Transcription confidence score (0-1) */
     confidence?: number | null;
+    /** ISO 8601 creation timestamp (included in project detail responses) */
+    createdAt?: string;
 }
 /**
  * Supported export format identifiers
@@ -120,7 +130,7 @@ interface ExportResult {
     filename: string;
     /** MIME type for the content */
     mimeType: string;
-    /** File extension (without dot) */
+    /** File extension (with dot, e.g., ".lrc") */
     extension: string;
 }
 /**
@@ -133,7 +143,7 @@ interface FormatInfo {
     name: string;
     /** Description of the format and its use cases */
     description: string;
-    /** File extension (without dot) */
+    /** File extension (with dot, e.g., ".lrc") */
     extension: string;
     /** MIME type */
     mimeType: string;
@@ -166,15 +176,13 @@ interface ListProjectsOptions {
  */
 interface ProjectsResult {
     /** Array of projects */
-    projects: Project[];
+    projects: ProjectSummary[];
     /** Total count of projects matching filters */
     total: number;
     /** Current limit */
     limit: number;
     /** Current offset */
     offset: number;
-    /** Whether there are more results */
-    hasMore: boolean;
 }
 /**
  * Options for getting a single project
@@ -182,13 +190,11 @@ interface ProjectsResult {
 interface GetProjectOptions {
     /** Include word-level timing data (default: true) */
     includeWords?: boolean;
-    /** Include segments (default: true) */
-    includeSegments?: boolean;
 }
 /**
- * A Syynk project containing synchronized content
+ * Project summary returned in list responses
  */
-interface Project {
+interface ProjectSummary {
     /** Unique project identifier */
     id: string;
     /** Project name/title */
@@ -199,25 +205,39 @@ interface Project {
     status: ProjectStatus;
     /** Audio/video duration in seconds */
     durationSeconds: number | null;
-    /** URL to the audio file (if stored) */
-    audioUrl: string | null;
-    /** URL to the video file (for subsync projects) */
-    videoUrl: string | null;
-    /** Error message if status is 'error' */
-    errorMessage?: string | null;
+    /** URL to open the project in the Syynk editor */
+    editorUrl: string;
     /** ISO 8601 creation timestamp */
     createdAt: string;
     /** ISO 8601 last update timestamp */
     updatedAt: string;
 }
 /**
- * Full project result including segments and words
+ * Full project details returned from getProject()
  */
-interface ProjectResult extends Project {
-    /** Project segments (included by default) */
+interface Project extends ProjectSummary {
+    /** URL to the audio file (if stored) */
+    audioUrl: string | null;
+}
+/**
+ * Result of getProject() - includes project details, segments, and optionally words
+ */
+interface ProjectResult {
+    /** Project details */
+    project: Project;
+    /** Project segments (always included) */
     segments: Segment[];
-    /** Project words (included by default) */
-    words: Word[];
+    /** Project words (included when includeWords is true) */
+    words?: Word[];
+}
+/**
+ * Result of getLyrics() - plain text lyrics for a project
+ */
+interface LyricsResult {
+    /** Project ID */
+    projectId: string;
+    /** Plain text lyrics (segments joined by newlines) */
+    lyrics: string;
 }
 /**
  * Rate limit information from API response headers
@@ -394,26 +414,40 @@ declare class SyynkClient {
      * Get a single project by ID
      *
      * @param id - Project ID
-     * @param options - Options for including segments/words
-     * @returns Project with segments and words
+     * @param options - Options for including words
+     * @returns Project with segments and optionally words
      *
      * @example
      * ```typescript
-     * const project = await client.getProject('project-id', {
+     * const result = await client.getProject('project-id', {
      *   includeWords: true,
      * });
-     * console.log(`Project has ${project.segments.length} segments`);
+     * console.log(`Project has ${result.segments.length} segments`);
      * ```
      */
     getProject(id: string, options?: GetProjectOptions): Promise<ProjectResult>;
     /**
-     * Delete a project by ID
+     * Get plain text lyrics for a project
+     *
+     * @param id - Project ID
+     * @returns Lyrics as plain text (segments joined by newlines)
+     *
+     * @example
+     * ```typescript
+     * const result = await client.getLyrics('project-id');
+     * console.log(result.lyrics);
+     * ```
+     */
+    getLyrics(id: string): Promise<LyricsResult>;
+    /**
+     * Delete a project and all its segments and words
      *
      * @param id - Project ID
      *
      * @example
      * ```typescript
      * await client.deleteProject('project-id');
+     * console.log('Project deleted');
      * ```
      */
     deleteProject(id: string): Promise<void>;
@@ -568,4 +602,4 @@ declare function isRateLimitError(error: unknown): error is RateLimitError;
  */
 declare function isRetryableError(error: unknown): boolean;
 
-export { type ApiErrorResponse, type ApiResponse, AuthenticationError, AuthorizationError, type ExportFormat, type ExportOptions, type ExportResult, type FormatInfo, type GetProjectOptions, type ListProjectsOptions, NetworkError, NotFoundError, type Project, type ProjectResult, type ProjectStatus, type ProjectType, type ProjectsResult, RateLimitError, type RateLimitInfo, type Segment, ServerError, SyynkClient, type SyynkClientOptions, SyynkError, TimeoutError, type TranscribeFileOptions, type TranscribeOptions, type TranscribeResult, ValidationError, type Word, isRateLimitError, isRetryableError, isSyynkError };
+export { type ApiErrorResponse, type ApiResponse, AuthenticationError, AuthorizationError, type ExportFormat, type ExportOptions, type ExportResult, type FormatInfo, type GetProjectOptions, type ListProjectsOptions, type LyricsResult, NetworkError, NotFoundError, type Project, type ProjectResult, type ProjectStatus, type ProjectSummary, type ProjectType, type ProjectsResult, RateLimitError, type RateLimitInfo, type Segment, ServerError, SyynkClient, type SyynkClientOptions, SyynkError, TimeoutError, type TranscribeFileOptions, type TranscribeOptions, type TranscribeResult, ValidationError, type Word, isRateLimitError, isRetryableError, isSyynkError };

package/dist/index.d.ts

@@ -45,10 +45,14 @@ interface TranscribeFileOptions {
 interface TranscribeResult {
     /** Unique identifier for the created project */
     projectId: string;
+    /** URL to open the project in the Syynk editor */
+    editorUrl: string;
     /** Detected or specified language code */
     language: string;
     /** Audio duration in seconds */
     duration: number;
+    /** Plain text lyrics (segments joined by newlines) */
+    lyricsText: string;
     /** Transcribed segments with line-level timestamps */
     segments: Segment[];
     /** Individual words with word-level timestamps */
@@ -73,6 +77,10 @@ interface Segment {
     speakerId?: string | null;
     /** Transcription confidence score (0-1) */
     confidence?: number | null;
+    /** ISO 8601 creation timestamp (included in project detail responses) */
+    createdAt?: string;
+    /** ISO 8601 last update timestamp (included in project detail responses) */
+    updatedAt?: string;
 }
 /**
  * A word with precise timestamp within a segment
@@ -92,6 +100,8 @@ interface Word {
     sortOrder: number;
     /** Transcription confidence score (0-1) */
     confidence?: number | null;
+    /** ISO 8601 creation timestamp (included in project detail responses) */
+    createdAt?: string;
 }
 /**
  * Supported export format identifiers
@@ -120,7 +130,7 @@ interface ExportResult {
     filename: string;
     /** MIME type for the content */
     mimeType: string;
-    /** File extension (without dot) */
+    /** File extension (with dot, e.g., ".lrc") */
     extension: string;
 }
 /**
@@ -133,7 +143,7 @@ interface FormatInfo {
     name: string;
     /** Description of the format and its use cases */
     description: string;
-    /** File extension (without dot) */
+    /** File extension (with dot, e.g., ".lrc") */
     extension: string;
     /** MIME type */
     mimeType: string;
@@ -166,15 +176,13 @@ interface ListProjectsOptions {
  */
 interface ProjectsResult {
     /** Array of projects */
-    projects: Project[];
+    projects: ProjectSummary[];
     /** Total count of projects matching filters */
     total: number;
     /** Current limit */
     limit: number;
     /** Current offset */
     offset: number;
-    /** Whether there are more results */
-    hasMore: boolean;
 }
 /**
  * Options for getting a single project
@@ -182,13 +190,11 @@ interface ProjectsResult {
 interface GetProjectOptions {
     /** Include word-level timing data (default: true) */
     includeWords?: boolean;
-    /** Include segments (default: true) */
-    includeSegments?: boolean;
 }
 /**
- * A Syynk project containing synchronized content
+ * Project summary returned in list responses
  */
-interface Project {
+interface ProjectSummary {
     /** Unique project identifier */
     id: string;
     /** Project name/title */
@@ -199,25 +205,39 @@ interface Project {
     status: ProjectStatus;
     /** Audio/video duration in seconds */
     durationSeconds: number | null;
-    /** URL to the audio file (if stored) */
-    audioUrl: string | null;
-    /** URL to the video file (for subsync projects) */
-    videoUrl: string | null;
-    /** Error message if status is 'error' */
-    errorMessage?: string | null;
+    /** URL to open the project in the Syynk editor */
+    editorUrl: string;
     /** ISO 8601 creation timestamp */
     createdAt: string;
     /** ISO 8601 last update timestamp */
     updatedAt: string;
 }
 /**
- * Full project result including segments and words
+ * Full project details returned from getProject()
  */
-interface ProjectResult extends Project {
-    /** Project segments (included by default) */
+interface Project extends ProjectSummary {
+    /** URL to the audio file (if stored) */
+    audioUrl: string | null;
+}
+/**
+ * Result of getProject() - includes project details, segments, and optionally words
+ */
+interface ProjectResult {
+    /** Project details */
+    project: Project;
+    /** Project segments (always included) */
     segments: Segment[];
-    /** Project words (included by default) */
-    words: Word[];
+    /** Project words (included when includeWords is true) */
+    words?: Word[];
+}
+/**
+ * Result of getLyrics() - plain text lyrics for a project
+ */
+interface LyricsResult {
+    /** Project ID */
+    projectId: string;
+    /** Plain text lyrics (segments joined by newlines) */
+    lyrics: string;
 }
 /**
  * Rate limit information from API response headers
@@ -394,26 +414,40 @@ declare class SyynkClient {
      * Get a single project by ID
      *
      * @param id - Project ID
-     * @param options - Options for including segments/words
-     * @returns Project with segments and words
+     * @param options - Options for including words
+     * @returns Project with segments and optionally words
      *
      * @example
      * ```typescript
-     * const project = await client.getProject('project-id', {
+     * const result = await client.getProject('project-id', {
      *   includeWords: true,
      * });
-     * console.log(`Project has ${project.segments.length} segments`);
+     * console.log(`Project has ${result.segments.length} segments`);
      * ```
      */
     getProject(id: string, options?: GetProjectOptions): Promise<ProjectResult>;
     /**
-     * Delete a project by ID
+     * Get plain text lyrics for a project
+     *
+     * @param id - Project ID
+     * @returns Lyrics as plain text (segments joined by newlines)
+     *
+     * @example
+     * ```typescript
+     * const result = await client.getLyrics('project-id');
+     * console.log(result.lyrics);
+     * ```
+     */
+    getLyrics(id: string): Promise<LyricsResult>;
+    /**
+     * Delete a project and all its segments and words
      *
      * @param id - Project ID
      *
      * @example
      * ```typescript
      * await client.deleteProject('project-id');
+     * console.log('Project deleted');
      * ```
      */
     deleteProject(id: string): Promise<void>;
@@ -568,4 +602,4 @@ declare function isRateLimitError(error: unknown): error is RateLimitError;
  */
 declare function isRetryableError(error: unknown): boolean;
 
-export { type ApiErrorResponse, type ApiResponse, AuthenticationError, AuthorizationError, type ExportFormat, type ExportOptions, type ExportResult, type FormatInfo, type GetProjectOptions, type ListProjectsOptions, NetworkError, NotFoundError, type Project, type ProjectResult, type ProjectStatus, type ProjectType, type ProjectsResult, RateLimitError, type RateLimitInfo, type Segment, ServerError, SyynkClient, type SyynkClientOptions, SyynkError, TimeoutError, type TranscribeFileOptions, type TranscribeOptions, type TranscribeResult, ValidationError, type Word, isRateLimitError, isRetryableError, isSyynkError };
+export { type ApiErrorResponse, type ApiResponse, AuthenticationError, AuthorizationError, type ExportFormat, type ExportOptions, type ExportResult, type FormatInfo, type GetProjectOptions, type ListProjectsOptions, type LyricsResult, NetworkError, NotFoundError, type Project, type ProjectResult, type ProjectStatus, type ProjectSummary, type ProjectType, type ProjectsResult, RateLimitError, type RateLimitInfo, type Segment, ServerError, SyynkClient, type SyynkClientOptions, SyynkError, TimeoutError, type TranscribeFileOptions, type TranscribeOptions, type TranscribeResult, ValidationError, type Word, isRateLimitError, isRetryableError, isSyynkError };

package/dist/index.js

@@ -292,7 +292,7 @@ var SyynkClient = class {
     if (options?.projectName) {
       formData.append("projectName", options.projectName);
     }
-    return this.request("/api/v1/transcribe/upload", {
+    return this.request("/api/v1/transcribe", {
       method: "POST",
       body: formData
       // Don't set Content-Type header - let the browser set it with boundary
@@ -339,9 +339,10 @@ var SyynkClient = class {
    * ```
    */
   async getFormats() {
-    return this.request("/api/v1/formats", {
+    const response = await this.request("/api/v1/export/formats", {
       method: "GET"
     });
+    return response.formats;
   }
   /**
    * List projects with optional filtering and pagination
@@ -382,15 +383,15 @@ var SyynkClient = class {
    * Get a single project by ID
    *
    * @param id - Project ID
-   * @param options - Options for including segments/words
-   * @returns Project with segments and words
+   * @param options - Options for including words
+   * @returns Project with segments and optionally words
    *
    * @example
    * ```typescript
-   * const project = await client.getProject('project-id', {
+   * const result = await client.getProject('project-id', {
    *   includeWords: true,
    * });
-   * console.log(`Project has ${project.segments.length} segments`);
+   * console.log(`Project has ${result.segments.length} segments`);
    * ```
    */
   async getProject(id, options) {
@@ -398,9 +399,6 @@ var SyynkClient = class {
     if (options?.includeWords !== void 0) {
       params.set("includeWords", String(options.includeWords));
     }
-    if (options?.includeSegments !== void 0) {
-      params.set("includeSegments", String(options.includeSegments));
-    }
     const queryString = params.toString();
     const path = queryString ? `/api/v1/projects/${id}?${queryString}` : `/api/v1/projects/${id}`;
     return this.request(path, {
@@ -408,13 +406,31 @@ var SyynkClient = class {
     });
   }
   /**
-   * Delete a project by ID
+   * Get plain text lyrics for a project
+   *
+   * @param id - Project ID
+   * @returns Lyrics as plain text (segments joined by newlines)
+   *
+   * @example
+   * ```typescript
+   * const result = await client.getLyrics('project-id');
+   * console.log(result.lyrics);
+   * ```
+   */
+  async getLyrics(id) {
+    return this.request(`/api/v1/projects/${id}/lyrics`, {
+      method: "GET"
+    });
+  }
+  /**
+   * Delete a project and all its segments and words
    *
    * @param id - Project ID
    *
    * @example
    * ```typescript
    * await client.deleteProject('project-id');
+   * console.log('Project deleted');
    * ```
    */
   async deleteProject(id) {

package/dist/index.mjs

@@ -254,7 +254,7 @@ var SyynkClient = class {
     if (options?.projectName) {
       formData.append("projectName", options.projectName);
     }
-    return this.request("/api/v1/transcribe/upload", {
+    return this.request("/api/v1/transcribe", {
       method: "POST",
       body: formData
       // Don't set Content-Type header - let the browser set it with boundary
@@ -301,9 +301,10 @@ var SyynkClient = class {
    * ```
    */
   async getFormats() {
-    return this.request("/api/v1/formats", {
+    const response = await this.request("/api/v1/export/formats", {
       method: "GET"
     });
+    return response.formats;
   }
   /**
    * List projects with optional filtering and pagination
@@ -344,15 +345,15 @@ var SyynkClient = class {
    * Get a single project by ID
    *
    * @param id - Project ID
-   * @param options - Options for including segments/words
-   * @returns Project with segments and words
+   * @param options - Options for including words
+   * @returns Project with segments and optionally words
    *
    * @example
    * ```typescript
-   * const project = await client.getProject('project-id', {
+   * const result = await client.getProject('project-id', {
    *   includeWords: true,
    * });
-   * console.log(`Project has ${project.segments.length} segments`);
+   * console.log(`Project has ${result.segments.length} segments`);
    * ```
    */
   async getProject(id, options) {
@@ -360,9 +361,6 @@ var SyynkClient = class {
     if (options?.includeWords !== void 0) {
       params.set("includeWords", String(options.includeWords));
     }
-    if (options?.includeSegments !== void 0) {
-      params.set("includeSegments", String(options.includeSegments));
-    }
     const queryString = params.toString();
     const path = queryString ? `/api/v1/projects/${id}?${queryString}` : `/api/v1/projects/${id}`;
     return this.request(path, {
@@ -370,13 +368,31 @@ var SyynkClient = class {
     });
   }
   /**
-   * Delete a project by ID
+   * Get plain text lyrics for a project
+   *
+   * @param id - Project ID
+   * @returns Lyrics as plain text (segments joined by newlines)
+   *
+   * @example
+   * ```typescript
+   * const result = await client.getLyrics('project-id');
+   * console.log(result.lyrics);
+   * ```
+   */
+  async getLyrics(id) {
+    return this.request(`/api/v1/projects/${id}/lyrics`, {
+      method: "GET"
+    });
+  }
+  /**
+   * Delete a project and all its segments and words
    *
    * @param id - Project ID
    *
    * @example
    * ```typescript
    * await client.deleteProject('project-id');
+   * console.log('Project deleted');
    * ```
    */
   async deleteProject(id) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@royalti/syynk",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "TypeScript SDK for Syynk API - transcribe audio and export synchronized lyrics/subtitles",
   "main": "dist/index.js",
   "module": "dist/index.mjs",