@cap-js/cds-types 0.1.0 → 0.2.0

package/apis/test.d.ts

@@ -1,68 +1,91 @@
-import { AxiosInstance } from 'axios';
-import chai from 'chai';
-import * as http from 'http';
-import { Service } from './services';
+import { AxiosInstance } from 'axios'
+import chai from 'chai'
+import * as http from 'http'
+import { Service } from './services'
 import * as cds from './cds'
 
 type _cds = typeof cds
 
 declare class Axios {
-  get axios(): AxiosInstance;
-
-  get     : AxiosInstance['get'];
-  put     : AxiosInstance['put'];
-  post    : AxiosInstance['post'];
-  patch   : AxiosInstance['patch'];
-  delete  : AxiosInstance['delete'];
-  options : AxiosInstance['options'];
-
-  get GET()     : Axios['get'];
-  get PUT()     : Axios['put'];
-  get POST()    : Axios['post'];
-  get PATCH()   : Axios['patch'];
-  get DELETE()  : Axios['delete'];
-  get OPTIONS() : Axios['options'];
+
+  get axios (): AxiosInstance
+  get: AxiosInstance['get'];
+
+  put: AxiosInstance['put']
+
+  post: AxiosInstance['post']
+
+  patch: AxiosInstance['patch']
+
+  delete: AxiosInstance['delete']
+
+  options: AxiosInstance['options']
+
+  get GET (): Axios['get']
+
+  get PUT (): Axios['put']
+
+  get POST (): Axios['post']
+
+  get PATCH (): Axios['patch']
+
+  get DELETE (): Axios['delete']
+
+  get OPTIONS (): Axios['options']
+
 }
 
 declare class DataUtil {
-  delete(db?: Service): Promise<void>;
-  reset(db?: Service): Promise<void>;
+
+  delete (db?: Service): Promise<void>
+
+  reset (db?: Service): Promise<void>
+
   /**
    * @deprecated if needed, call `reset()`, considering test performance
    */
-  autoReset(enabled: boolean): this;
+  autoReset (enabled: boolean): this
+
 }
 
 declare class Test extends Axios {
 
-  test : Test
+  test: Test
+
+  run (cmd: string, ...args: string[]): this
+
+  in (...paths: string[]): this
+
+  silent (): this
 
-  run(cmd: string, ...args: string[]): this;
-  in(...paths: string[]): this;
-  silent(): this;
   /**
    * @deprecated Server log is shown by default. Use `log()` to get control over it.
    */
-  verbose(v: boolean): this;
-
-  get chai(): typeof chai;
-  get expect(): typeof chai.expect;
-  get assert(): typeof chai.assert;
-  get data(): DataUtil;
-  get cds(): _cds
-
-  log() : {
-    output: string
-    clear(): void
-    release(): void
+  verbose (v: boolean): this
+
+  get chai (): typeof chai
+
+  get expect (): typeof chai.expect
+
+  get assert (): typeof chai.assert
+
+  get data (): DataUtil
+
+  get cds (): _cds
+
+  log (): {
+    output: string,
+    clear(): void,
+    release(): void,
   }
 
-  then(r: (args: { server: http.Server, url: string }) => void): void;
+  then (r: (args: { server: http.Server, url: string }) => void): void
 
   // get sleep(): (ms: number) => Promise<void>;
   // get spy(): <T, K extends keyof T>(o: T, f: K) => T[K] extends (...args: infer TArgs) => infer TReturnValue
   //   ? Spy<TArgs, TReturnValue>
   //   : Spy;
+
 }
 
 // typings for spy inspired by @types/sinon
@@ -73,15 +96,17 @@ declare class Test extends Axios {
 // }
 
 declare const test: {
-    Test: typeof Test
-    /**
+  Test: typeof Test,
+
+  /**
      * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test#class-cds-test-test)
      */
-    (dirname: string): Test;
-    /**
+  (dirname: string): Test,
+
+  /**
      * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test#class-cds-test-test)
      */
-    (command: string, ...args: string[]): Test;
+  (command: string, ...args: string[]): Test,
 
-    in (dirname: string) : Test
+  in (dirname: string): Test,
 }

package/apis/utils.d.ts

@@ -3,87 +3,88 @@ import * as fs from 'node:fs'
 /**
  * Provides a set of utility functionss
  */
-declare const utils : {
-	/**
+declare const utils: {
+
+  /**
 	 * Generates a new v4 UUID
 	 * @see https://cap.cloud.sap/docs/node.js/cds-facade#cds-utils
 	 */
-	uuid () : string
+  uuid (): string,
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#decodeuri
 	 */
-	decodeURI(input: string): string
+  decodeURI(input: string): string,
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#decodeuricomponent
 	 */
-	decodeURIComponent(input: string): string
+  decodeURIComponent(input: string): string,
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#local-filename
 	 */
-	local(filename: string): string
+  local(filename: string): string,
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#exists-file
 	 */
-	exist(file: string): boolean
+  exist(file: string): boolean,
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#isdir-file
 	 */
-	isdir(file: string): string
+  isdir(file: string): string,
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#isdir-file
 	 */
-	isfile(file: string): string
+  isfile(file: string): string,
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-read-file
 	 */
-	read(file: string): Promise<Buffer | {}>
+  read(file: string): Promise<Buffer | object>,
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-write-data-to-file
 	 */
-	write: {
-		(data: Object): {
-			to(...file: string[]): Promise<ReturnType<typeof fs.promises.writeFile>>
-		}
-		(file: string, data: Object): Promise<ReturnType<typeof fs.promises.writeFile>>
-	}
-
-	/** 
+  write: {
+    (data: object): {
+      to(...file: string[]): Promise<ReturnType<typeof fs.promises.writeFile>>,
+    },
+    (file: string, data: object): Promise<ReturnType<typeof fs.promises.writeFile>>,
+  },
+
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-copy-src-to-dst
 	 */
-	copy: {
-		(src: string): {
-			to(...dst: string[]): Promise<ReturnType<typeof fs.promises.copyFile>>
-		}
-		(dst: string, src: string): Promise<ReturnType<typeof fs.promises.copyFile>>
-	}
-	
-	/** 
+  copy: {
+    (src: string): {
+      to(...dst: string[]): Promise<ReturnType<typeof fs.promises.copyFile>>,
+    },
+    (dst: string, src: string): Promise<ReturnType<typeof fs.promises.copyFile>>,
+  },
+
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-mkdirp-path
 	 */
-	mkdirp: (...path: string[]) => Promise<string>	
-	
-	/** 
+  mkdirp: (...path: string[]) => Promise<string>,
+
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-rmdir-path
 	 */
-	rmdir: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>	
-		
+  rmdir: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>,
+
 
-	/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-rimraf-path
 	 */
-		rimraf: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>	
-		
+  rimraf: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>,
+
 
-		/** 
+  /**
 	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-rm-path
 	 */
-		rm: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>	
+  rm: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-types",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Type definitions for main packages of CAP, like `@sap/cds`",
   "repository": "github:cap-js/cds-types",
   "homepage": "https://cap.cloud.sap/",
@@ -19,16 +19,24 @@
   ],
   "scripts": {
     "test": "jest --silent",
-    "api-extractor": "api-extractor run --local --verbose"
+    "api-extractor": "api-extractor run --local --verbose",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "setup": "npm i && npm i file:. --no-save --force"
   },
   "peerDependencies": {
     "@sap/cds": ">=7"
   },
   "devDependencies": {
-    "@sap/cds": "^7.4.0",
+    "@sap/cds": "^7.5.0",
+    "@stylistic/eslint-plugin": "^1.5.3",
+    "@types/jest": "^29.5.11",
     "@types/node": "^20",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
     "axios": "^1.6.2",
     "chai": "^4.3.10",
+    "eslint": "^8.56.0",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.1",
     "typescript": "^5.3.2",