bump to 0.0.13

packages/aitube-client/README.md

@@ -28,11 +28,21 @@ npm install @aitube/client
 ```typescript
 import {
   createClap,
-  editClapEntities,
   editClapDialogues,
+  editClapEntities,
   editClapStoryboards,
   editClapVideos,
-  exportClapToVideo
+  exportClapToVideo,
+  defaultAitubeHostname,
+  defaultClapWidth,
+  defaultClapHeight,
+  defaultExportFormat,
+  aitubeUrl,
+  aitubeApiVersion,
+  aitubeApiUrl,
+  ClapCompletionMode,
+  ClapEntityPrompt,
+  SupportedExportFormat
   } from '@aitube/client';
 
 const ultraSecret = "ultra secret token unavailable to common mortals"

packages/aitube-client/package.json

@@ -4,7 +4,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Official API client for AiTube.at",
   "scripts": {
     "build": "bun build --target=node ./src/index.ts --outfile=dist/index.js && bun run build:declaration",
@@ -38,5 +38,8 @@
     "dist/*.js",
     "dist/*.d.ts",
     "dist/**/*.d.ts"
-  ]
+  ],
+  "dependencies": {
+    "query-string": "^9.0.0"
+  }
 }

packages/aitube-client/src/api/createClap.ts

@@ -1,11 +1,13 @@
 import { ClapProject, fetchClap } from "@aitube/clap"
 
-import { aitubeApiUrl } from "@/config"
+import { aitubeApiUrl } from "@/constants/config"
+
+import { defaultClapHeight, defaultClapWidth } from "@/constants/defaultValues"
 
 export async function createClap({
   prompt,
-  height = 512,
-  width = 288,
+  height = defaultClapHeight,
+  width = defaultClapWidth,
   token,
 }: {
   prompt: string

packages/aitube-client/src/api/editClapDialogues.ts

@@ -1,7 +1,8 @@
 import { ClapProject, fetchClap, serializeClap } from "@aitube/clap"
 
-import { aitubeApiUrl } from "@/config"
-import { ClapCompletionMode } from "./types"
+import { aitubeApiUrl } from "@/constants/config"
+
+import { ClapCompletionMode } from "../constants/types"
 
 export async function editClapDialogues({
   clap,

packages/aitube-client/src/api/editClapEntities.ts

@@ -1,16 +1,22 @@
 import { ClapProject, fetchClap, serializeClap } from "@aitube/clap"
+import queryString from "query-string"
 
-import { aitubeApiUrl } from "@/config"
-import { ClapCompletionMode } from "./types"
+import { aitubeApiUrl } from "@/constants/config"
+
+import { ClapCompletionMode, ClapEntityPrompt } from "../constants/types"
 
 export async function editClapEntities({
   clap,
+  entityPrompts = [],
   completionMode = ClapCompletionMode.MERGE,
   token,
 }: {
   // A ClapProject instance
   clap: ClapProject
 
+  // a list of entity prompts
+  entityPrompts: ClapEntityPrompt[],
+
   /**
    * Completion mode (optional, defaults to "merge")
    * 
@@ -29,16 +35,24 @@ export async function editClapEntities({
   
   const hasToken = typeof token === "string" && token.length > 0
 
+  const params: Record<string, any> = {}
+
+  if (typeof completionMode === "string") {
+    params.c = completionMode === ClapCompletionMode.FULL
+      ? "full"
+      : "partial"
+  }
+
+  if (entityPrompts.length) {
+    // if "params.e = JSON.stringify(item)" works with UTF-8 characters,
+    // then we don't need to import "js-base64"
+    // otherwise you will have to do:
+    // params.e = jsBase64.encode(JSON.stringify(item))
+    params.e = JSON.stringify(entityPrompts)
+  }
+
   const newClap = await fetchClap(
-    `${aitubeApiUrl}edit/entities${
-      typeof completionMode === "string"
-      ? `?c=${
-          completionMode === ClapCompletionMode.FULL
-          ? "full"
-          : "partial"
-        }`
-      : ""
-    }`, {
+    `${aitubeApiUrl}edit/entities?${queryString.stringify(params)}`, {
     method: "POST",
     headers: {
       "Content-Type": "application/x-gzip",

packages/aitube-client/src/api/editClapStoryboards.ts

@@ -1,7 +1,8 @@
 import { ClapProject, fetchClap, serializeClap } from "@aitube/clap"
 
-import { aitubeApiUrl } from "@/config"
-import { ClapCompletionMode } from "./types"
+import { aitubeApiUrl } from "@/constants/config"
+
+import { ClapCompletionMode } from "../constants/types"
 
 export async function editClapStoryboards({
   clap,

packages/aitube-client/src/api/editClapVideos.ts

@@ -1,7 +1,8 @@
 import { ClapProject, fetchClap, serializeClap } from "@aitube/clap"
 
-import { aitubeApiUrl } from "@/config"
-import { ClapCompletionMode } from "./types"
+import { aitubeApiUrl } from "@/constants/config"
+
+import { ClapCompletionMode } from "../constants/types"
 
 export async function editClapVideos({
   clap,

packages/aitube-client/src/api/exportClapToVideo.ts

@@ -1,6 +1,6 @@
 import { ClapProject, serializeClap, blobToDataUri } from "@aitube/clap"
 
-import { aitubeApiUrl } from "@/config"
+import { aitubeApiUrl } from "@/constants/config"
 
 export type SupportedExportFormat = "mp4" | "webm"
 export const defaultExportFormat = "mp4"

packages/aitube-client/src/api/index.ts

@@ -4,4 +4,3 @@ export { editClapVideos } from "./editClapVideos"
 export { editClapDialogues } from "./editClapDialogues"
 export { editClapEntities } from "./editClapEntities"
 export { createClap } from "./createClap"
-export { ClapCompletionMode } from "./types"

packages/aitube-client/src/{config.ts → constants/config.ts}

@@ -1,9 +1,4 @@
-
-// unfortunately, this doesn't work yet due to a redirection issue
-// const defaultAitubeHostname = "aitube.at"
-
-// so we have to use the direct space hostname instead
-export const defaultAitubeHostname = "jbilcke-hf-ai-tube.hf.space"
+import { defaultAitubeHostname } from "./defaultValues"
 
 // we leave the opportunity to override this at runtime
 export const aitubeUrl = `${

packages/aitube-client/src/constants/defaultValues.ts

@@ -0,0 +1,10 @@
+// unfortunately, this doesn't work yet due to a redirection issue
+// const defaultAitubeHostname = "aitube.at"
+
+// so we have to use the direct space hostname instead
+export const defaultAitubeHostname = "jbilcke-hf-ai-tube.hf.space"
+
+export const defaultClapWidth = 512
+export const defaultClapHeight = 288
+
+export const defaultExportFormat = "mp4"

packages/aitube-client/src/constants/index.ts

@@ -0,0 +1,18 @@
+export {
+  defaultAitubeHostname,
+  defaultClapWidth,
+  defaultClapHeight,
+  defaultExportFormat
+} from './defaultValues'
+
+export {
+  aitubeUrl,
+  aitubeApiVersion,
+  aitubeApiUrl
+} from './config'
+
+export {
+  ClapCompletionMode,
+  ClapEntityPrompt,
+  SupportedExportFormat
+} from "./types"

packages/aitube-client/src/{api → constants}/types.ts

@@ -1,3 +1,5 @@
+export type SupportedExportFormat = "mp4" | "webm"
+
 export enum ClapCompletionMode {
   /**
    * the API and the client will return a full clap file.
@@ -25,4 +27,24 @@ export enum ClapCompletionMode {
    * This is the most efficient mode, but it relies on side-effects and inline object updates.
    */
   REPLACE = "replace"
+}
+
+
+export type ClapEntityPrompt = {
+  name: string
+
+  // age of the person, animal or entity (eg. robot, talking spaceship etc)
+  age: string
+
+  // characterization of the person, animal or entity (texture, hair color, gender etc)
+  variant: string
+
+  // region from where the person, animal or entity is coming from (human, mechanical, alien planet, european, south-american etc)
+  region: string
+
+  // identity picture
+  identityImage: string
+
+  // identity voice
+  identityVoice: string
 }

packages/aitube-client/src/index.ts

@@ -6,12 +6,17 @@ export {
   editClapStoryboards,
   editClapVideos,
   exportClapToVideo,
-  ClapCompletionMode,
 } from './api'
 
 export {
   defaultAitubeHostname,
+  defaultClapWidth,
+  defaultClapHeight,
+  defaultExportFormat,
   aitubeUrl,
   aitubeApiVersion,
-  aitubeApiUrl
-} from './config'
+  aitubeApiUrl,
+  ClapCompletionMode,
+  ClapEntityPrompt,
+  SupportedExportFormat
+} from "./constants"

packages/aitube-client/src/parsers/index.ts

@@ -0,0 +1,3 @@
+export { parseEntityPrompt } from "./parseEntityPrompt"
+export { parseString } from "./parseString"
+export { parseStringArray } from "./parseStringArray"

packages/aitube-client/src/parsers/parseEntityPrompt.ts

@@ -0,0 +1,27 @@
+
+
+import { ClapEntityPrompt } from "@/constants/types"
+
+import { parseString } from "./parseString"
+
+export function parseEntityPrompt(entityPrompt: Partial<ClapEntityPrompt> = {}): ClapEntityPrompt {
+
+  return {
+    name: parseString(entityPrompt?.name),
+
+    // age of the person, animal or entity (eg. robot, talking spaceship etc)
+    age: parseString(entityPrompt?.age),
+
+    // characterization of the person, animal or entity (texture, hair color, gender etc)
+    variant: parseString(entityPrompt?.variant),
+
+    // region from where the person, animal or entity is coming from (human, mechanical, alien planet, european, south-american etc)
+    region: parseString(entityPrompt?.region),
+
+    // identity picture
+    identityImage: parseString(entityPrompt?.identityImage),
+
+    // identity voice
+    identityVoice: parseString(entityPrompt?.identityVoice),
+  }
+}

packages/aitube-client/src/parsers/parseString.ts

@@ -0,0 +1,7 @@
+export function parseString(input?: any, defaultValue?: string): string {
+  const defValue = `${defaultValue || ""}`
+
+  if (typeof input !== "string") { return defValue }
+  
+  return input || defValue
+}

packages/aitube-client/src/parsers/parseStringArray.ts

@@ -0,0 +1,9 @@
+export function parseStringArray(something: any): string[] {
+  let result: string[] = []
+  if (typeof something === "string") {
+    result = [something]
+  } else if (Array.isArray(something)) {
+    result = something.map(thing => typeof thing === "string" ? thing : "").filter(x => x)
+  }
+  return result
+}