JS Server: Just prettified tdkSchema.ts

Author: snej

servers/javascript/src/tdkSchema.ts

@@ -36,27 +36,27 @@ export interface TDK {
 export const GetInfoCommand = "/";
 
 export interface GetInfoResponse {
-    version: string,
-    apiVersion: number,
-    cbl: "couchbase-lite-js",
-    device: Record<string,string>,
-    additionalInfo?: string,
+    version         : string,
+    apiVersion      : number,
+    cbl             : "couchbase-lite-js",
+    device          : Record<string,string>,
+    additionalInfo? : string,
 }
 
 
 export const ResetCommand = "/reset";
 
 export interface ResetRequest extends TestRequest {
-    databases: null | Record<string, {collections: string[] | undefined} | {dataset: string}>;
-    test: string | undefined;
+    databases   : null | Record<string, {collections: string[] | undefined} | {dataset: string}>;
+    test        : string | undefined;
 }
 
 
 export const GetAllDocumentsCommand = "/getAllDocuments";
 
 export interface GetAllDocumentsRequest extends TestRequest {
-    database: string,
-    collections: string[],
+    database    : string,
+    collections : string[],
 }
 
 export type GetAllDocumentsResponse = Record<string, Array<{id:cbl.DocID, rev:cbl.RevID}>>;
@@ -65,185 +65,185 @@ export type GetAllDocumentsResponse = Record<string, Array<{id:cbl.DocID, rev:cb
 export const GetDocumentCommand = "/getDocument";
 
 export interface GetDocumentRequest extends TestRequest {
-    database: string,
-    document: {
-        collection: string,
-        id: cbl.DocID
+    database        : string,
+    document : {
+        collection  : string,
+        id          : cbl.DocID
     }
 }
 
 export type GetDocumentResponse = cbl.JSONObject & {
-    _id: cbl.DocID,
-    _revs: string,  // comma-delimited RevIDs
+    _id     : cbl.DocID,
+    _revs   : string,  // comma-delimited RevIDs
 }
 
 
 export const UpdateDatabaseCommand = "/updateDatabase";
 
 export interface UpdateDatabaseRequest extends TestRequest {
-    database: string,
-    updates: DatabaseUpdateItem[],
+    database    : string,
+    updates     : DatabaseUpdateItem[],
 }
 
 export interface DatabaseUpdateItem {
-    type: 'UPDATE' | 'DELETE' | 'PURGE',
-    collection: string,
-    documentID: cbl.DocID,
-    updatedProperties?: cbl.JSONObject[],
-    removedProperties?: string[],
-    updatedBlobs?: Record<string,string>,                   // KeyPath -> blob URL
+    type                : 'UPDATE' | 'DELETE' | 'PURGE',
+    collection          : string,
+    documentID          : cbl.DocID,
+    updatedProperties?  : cbl.JSONObject[],
+    removedProperties?  : string[],
+    updatedBlobs?       : Record<string,string>,                   // KeyPath -> blob URL
 }
 
 
 export const StartReplicatorCommand = "/startReplicator";
 
 export interface StartReplicatorRequest extends TestRequest {
     config: {
-        database: string,
-        collections: ReplicatorCollection[],
-        endpoint: string,
-        replicatorType?: 'push' | 'pull' | 'pushAndPull',   // default is 'pushAndPull'
-        continuous?: boolean,
-        authenticator?: ReplicatorAuthenticator,
+        database            : string,
+        collections         : ReplicatorCollection[],
+        endpoint            : string,
+        replicatorType?     : 'push' | 'pull' | 'pushAndPull',   // default is 'pushAndPull'
+        continuous?         : boolean,
+        authenticator?      : ReplicatorAuthenticator,
         enableDocumentListener?: boolean,
-        enableAutoPurge?: boolean,                          // default is true
-        headers?: Record<string,string>,
-        pinnedServerCert?: string,
+        enableAutoPurge?    : boolean,                          // default is true
+        headers?            : Record<string,string>,
+        pinnedServerCert?   : string,
     },
-    reset?: boolean,
+    reset?                  : boolean,
 }
 
 export interface ReplicatorCollection {
-    names: string[],
-    channels?: string[],
-    documentIDs?: cbl.DocID[],
-    pushFilter?: Filter,
-    pullFilter?: Filter,
-    conflictResolver?: Filter,
+    names               : string[],
+    channels?           : string[],
+    documentIDs?        : cbl.DocID[],
+    pushFilter?         : Filter,
+    pullFilter?         : Filter,
+    conflictResolver?   : Filter,
 }
 
 export interface Filter {
-    name: string,
-    params?: cbl.JSONObject,
+    name        : string,
+    params?     : cbl.JSONObject,
 }
 
 export interface ReplicatorAuthenticator {
-    type: 'BASIC' | 'SESSION',
+    type        : 'BASIC' | 'SESSION',
 }
 
 export interface ReplicatorBasicAuthenticator extends ReplicatorAuthenticator {
-    type: 'BASIC',
-    username: string,
-    password: string,
+    type        : 'BASIC',
+    username    : string,
+    password    : string,
 }
 
 export interface ReplicatorSessionAuthenticator extends ReplicatorAuthenticator {
-    type: 'SESSION',
-    sessionID: string,
-    cookieName: string,
+    type        : 'SESSION',
+    sessionID   : string,
+    cookieName  : string,
 }
 
 export interface StartReplicatorResponse {
-    id: string
+    id          : string
 }
 
 
 export const StopReplicatorCommand = "/stopReplicator";
 
 export interface StopReplicatorRequest extends TestRequest {
-    id: string,
+    id          : string,
 }
 
 
 export const GetReplicatorStatusCommand = "/getReplicatorStatus";
 
 export interface GetReplicatorStatusRequest extends TestRequest {
-    id: string,
+    id          : string,
 }
 
 export interface GetReplicatorStatusResponse {
-    activity: string,
-    progress: {completed: boolean},
-    documents?: DocumentReplication[],
-    error?: ErrorInfo,
+    activity    : string,
+    progress    : {completed: boolean},
+    documents?  : DocumentReplication[],
+    error?      : ErrorInfo,
 }
 
 export interface DocumentReplication {
-    collection: string,
-    documentID: cbl.DocID,
-    isPush?: boolean,
-    flags?: Array<'deleted' | 'accessRemoved'>;
-    error?: ErrorInfo
+    collection  : string,
+    documentID  : cbl.DocID,
+    isPush?     : boolean,
+    flags?      : Array<'deleted' | 'accessRemoved'>;
+    error?      : ErrorInfo
 }
 
 export interface ErrorInfo {
-    domain: string,
-    code: number,
-    message: string,
+    domain      : string,
+    code        : number,
+    message     : string,
 }
 
 
 export const SnapshotDocumentsCommand = "/snapshotDocuments";
 
 export interface SnapshotDocumentsRequest extends TestRequest {
-    database: string,
-    documents: Array<{collection: string, id: cbl.DocID}>,
+    database    : string,
+    documents   : Array<{collection: string, id: cbl.DocID}>,
 }
 
 export interface SnapshotDocumentsResponse {
-    id: string,
+    id          : string,
 }
 
 
 export const VerifyDocumentsCommand = "/verifyDocuments";
 
 export interface VerifyDocumentsRequest extends TestRequest {
-    database: string,
-    snapshot: string,
-    changes: DatabaseUpdateItem[],
+    database    : string,
+    snapshot    : string,
+    changes     : DatabaseUpdateItem[],
 }
 
 export interface VerifyDocumentsResponse {
-    result: boolean,
+    result      : boolean,
     description?: string,
-    actual?: cbl.JSONValue,
-    expected?: cbl.JSONValue,
-    document?: cbl.CBLDocument | cbl.JSONObject,     // Document will stringify to an object
+    actual?     : cbl.JSONValue,
+    expected?   : cbl.JSONValue,
+    document?   : cbl.CBLDocument | cbl.JSONObject,     // Document will stringify to an object
 }
 
 
 export const PerformMaintenanceCommand = "/performMaintenance";
 
 export interface PerformMaintenanceRequest extends TestRequest {
-    database: string,
-    maintenanceType: 'compact' | 'integrityCheck' | 'optimize' | 'fullOptimize',
+    database        : string,
+    maintenanceType : 'compact' | 'integrityCheck' | 'optimize' | 'fullOptimize',
 }
 
 
 export const NewSessionCommand = "/newSession";
 
 export interface NewSessionRequest extends TestRequest {
-    id: string,
-    logging?: {url: string, tag: string},
+    id          : string,
+    logging?    : {url: string, tag: string},
 }
 
 
 export const RunQueryCommand = "/runQuery";
 
 export interface RunQueryRequest extends TestRequest {
-    database: string,
-    query: string,
+    database    : string,
+    query       : string,
 }
 
 export interface RunQueryResponse {
-    results: cbl.JSONArray,
+    results     : cbl.JSONArray,
 }
 
 
 export const LogCommand = "/log";
 
 export interface LogRequest extends TestRequest {
-    message: string,
+    message     : string,
 }
 
 
@@ -256,10 +256,10 @@ export const kBlobBaseURL = "https://media.githubusercontent.com/media/couchbase
 
 /** Schema of `index.json` */
 export interface DatasetIndex {
-    name: string,
-    collections: string[],
+    name        : string,
+    collections : string[],
 }
 
 export type DatasetDoc = cbl.JSONObject & {
-    _id: string,
+    _id         : string,
 }