"use strict";
export class QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
skip;
/** @type {?number} */
take;
/** @type {string} */
orderBy;
/** @type {string} */
orderByDesc;
/** @type {string} */
include;
/** @type {string} */
fields;
/** @type {{ [index:string]: string; }} */
meta;
}
/** @typedef T {any} */
export class QueryDb extends QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class AuditBase {
/** @param {{createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
createdDate;
/** @type {string} */
createdBy;
/** @type {string} */
modifiedDate;
/** @type {string} */
modifiedBy;
/** @type {?string} */
deletedDate;
/** @type {string} */
deletedBy;
}
export class Artifact extends AuditBase {
/** @param {{id?:number,creativeId?:number,fileName?:string,filePath?:string,contentType?:string,contentLength?:number,width?:number,height?:number,seed?:number,prompt?:string,nsfw?:boolean,averageHash?:number,perceptualHash?:number,differenceHash?:number,background?:string,lqip?:string,quality?:number,likesCount?:number,albumsCount?:number,downloadsCount?:number,searchCount?:number,temporalScore?:number,score?:number,rank?:number,refId?:string,versions?:{ [index:string]: string; },createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
creativeId;
/** @type {string} */
fileName;
/** @type {string} */
filePath;
/** @type {string} */
contentType;
/** @type {number} */
contentLength;
/** @type {number} */
width;
/** @type {number} */
height;
/** @type {number} */
seed;
/** @type {string} */
prompt;
/** @type {?boolean} */
nsfw;
/** @type {?number} */
averageHash;
/** @type {?number} */
perceptualHash;
/** @type {?number} */
differenceHash;
/** @type {?string} */
background;
/** @type {?string} */
lqip;
/** @type {number} */
quality;
/** @type {number} */
likesCount;
/** @type {number} */
albumsCount;
/** @type {number} */
downloadsCount;
/** @type {number} */
searchCount;
/** @type {number} */
temporalScore;
/** @type {number} */
score;
/** @type {number} */
rank;
/** @type {string} */
refId;
/** @type {{ [index:string]: string; }} */
versions = {};
}
export class AlbumArtifact {
/** @param {{id?:number,albumId?:number,artifactId?:number,description?:string,createdDate?:string,modifiedDate?:string,artifact?:Artifact}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
albumId;
/** @type {number} */
artifactId;
/** @type {?string} */
description;
/** @type {string} */
createdDate;
/** @type {string} */
modifiedDate;
/** @type {?Artifact} */
artifact;
}
export class Album extends AuditBase {
/** @param {{id?:number,name?:string,description?:string,slug?:string,tags?:string[],refId?:string,ownerId?:number,ownerRef?:string,primaryArtifactId?:number,private?:boolean,rating?:number,likesCount?:number,downloadsCount?:number,searchCount?:number,score?:number,rank?:number,prefColumns?:number,artifacts?:AlbumArtifact[],createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
id;
/** @type {?string} */
name;
/** @type {string} */
description;
/** @type {string} */
slug;
/** @type {string[]} */
tags = [];
/** @type {string} */
refId;
/** @type {number} */
ownerId;
/** @type {string} */
ownerRef;
/** @type {?number} */
primaryArtifactId;
/** @type {boolean} */
private;
/** @type {?number} */
rating;
/** @type {number} */
likesCount;
/** @type {number} */
downloadsCount;
/** @type {number} */
searchCount;
/** @type {number} */
score;
/** @type {number} */
rank;
/** @type {?number} */
prefColumns;
/** @type {AlbumArtifact[]} */
artifacts = [];
}
export class QueryAlbums extends QueryDb {
/** @param {{id?:number,ids?:number[],skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
id;
/** @type {?number[]} */
ids;
}
export class ArtifactResult extends Artifact {
/** @param {{userPrompt?:string,artistNames?:string[],modifierNames?:string[],primaryArtifactId?:number,ownerRef?:string,similarity?:number,id?:number,creativeId?:number,fileName?:string,filePath?:string,contentType?:string,contentLength?:number,width?:number,height?:number,seed?:number,prompt?:string,nsfw?:boolean,averageHash?:number,perceptualHash?:number,differenceHash?:number,background?:string,lqip?:string,quality?:number,likesCount?:number,albumsCount?:number,downloadsCount?:number,searchCount?:number,temporalScore?:number,score?:number,rank?:number,refId?:string,versions?:{ [index:string]: string; },createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
userPrompt;
/** @type {string[]} */
artistNames = [];
/** @type {string[]} */
modifierNames = [];
/** @type {?number} */
primaryArtifactId;
/** @type {string} */
ownerRef;
/** @type {?number} */
similarity;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index:string]: string; },responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
total;
/** @type {T[]} */
results;
/** @type {{ [index:string]: string; }} */
meta;
/** @type {ResponseStatus} */
responseStatus;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/QueryAlbums HTTP/1.1
Host: blazordiffusion.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
ids:
[
0
],
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
id: 0,
name: String,
description: String,
slug: String,
tags:
[
String
],
refId: String,
ownerId: 0,
ownerRef: String,
primaryArtifactId: 0,
private: False,
rating: 0,
likesCount: 0,
downloadsCount: 0,
searchCount: 0,
score: 0,
rank: 0,
prefColumns: 0,
artifacts:
[
{
id: 0,
albumId: 0,
artifactId: 0,
description: String,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
artifact:
{
id: 0,
creativeId: 0,
fileName: String,
filePath: String,
contentType: String,
contentLength: 0,
width: 0,
height: 0,
seed: 0,
prompt: String,
nsfw: False,
averageHash: 0,
perceptualHash: 0,
differenceHash: 0,
background: String,
lqip: String,
quality: 0,
likesCount: 0,
albumsCount: 0,
downloadsCount: 0,
searchCount: 0,
temporalScore: 0,
score: 0,
rank: 0,
refId: String,
versions:
{
String: String
},
createdDate: 0001-01-01,
createdBy: String,
modifiedDate: 0001-01-01,
modifiedBy: String,
deletedDate: 0001-01-01,
deletedBy: String
}
}
],
createdDate: 0001-01-01,
createdBy: String,
modifiedDate: 0001-01-01,
modifiedBy: String,
deletedDate: 0001-01-01,
deletedBy: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}