fable-serviceproviderbase 3.0.14 → 3.0.16

package/.browserslistrc

@@ -1 +1 @@
-> 0.01%
+since 2020

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fable-serviceproviderbase",
-    "version": "3.0.14",
+    "version": "3.0.16",
     "description": "Simple base classes for fable services.",
     "main": "source/Fable-ServiceProviderBase.js",
     "scripts": {
@@ -8,8 +8,11 @@
         "test": "npx mocha -u tdd -R spec",
         "tests": "npx mocha -u tdd --exit -R spec --grep",
         "coverage": "npx nyc --reporter=lcov --reporter=text-lcov npx mocha -- -u tdd -R spec",
-        "build": "npx quack build"
+        "build": "npx quack build",
+        "types": "tsc -p ./tsconfig.build.json",
+        "check": "tsc -p . --noEmit"
     },
+    "types": "types/source/Fable-ServiceProviderBase.d.ts",
     "mocha": {
         "diff": true,
         "extension": [
@@ -43,7 +46,9 @@
     },
     "homepage": "https://github.com/stevenvelozo/fable-serviceproviderbase",
     "devDependencies": {
-        "fable": "^3.0.143",
-        "quackage": "^1.0.33"
+        "@types/mocha": "^10.0.10",
+        "fable": "^3.1.51",
+        "quackage": "^1.0.45",
+        "typescript": "^5.9.3"
     }
-}
+}

package/source/Fable-ServiceProviderBase.js

@@ -3,13 +3,32 @@
 * @author <steven@velozo.com>
 */
 
+const libPackage = require('../package.json');
+
 class FableServiceProviderBase
 {
-	// The constructor can be used in two ways:
-	// 1) With a fable, options object and service hash (the options object and service hash are optional)
-	// 2) With an object or nothing as the first parameter, where it will be treated as the options object
+	/**
+	 * The constructor can be used in two ways:
+	 * 1) With a fable, options object and service hash (the options object and service hash are optional)a
+	 * 2) With an object or nothing as the first parameter, where it will be treated as the options object
+	 *
+	 * @param {import('fable')|Record<string, any>} [pFable] - (optional) The fable instance, or the options object if there is no fable
+	 * @param {Record<string, any>|string} [pOptions] - (optional) The options object, or the service hash if there is no fable
+	 * @param {string} [pServiceHash] - (optional) The service hash to identify this service instance
+	 */
 	constructor(pFable, pOptions, pServiceHash)
 	{
+		/** @type {import('fable')} */
+		this.fable;
+		/** @type {string} */
+		this.UUID;
+		/** @type {Record<string, any>} */
+		this.options;
+		/** @type {Record<string, any>} */
+		this.services;
+		/** @type {Record<string, any>} */
+		this.servicesMap;
+
 		// Check if a fable was passed in; connect it if so
 		if ((typeof(pFable) === 'object') && pFable.isFable)
 		{
@@ -21,7 +40,8 @@ class FableServiceProviderBase
 		}
 
 		// Initialize the services map if it wasn't passed in
-		this._PackageFableServiceProvider = require('../package.json');
+		/** @type {Record<string, any>} */
+		this._PackageFableServiceProvider = libPackage;
 
 		// initialize options and UUID based on whether the fable was passed in or not.
 		if (this.fable)
@@ -49,6 +69,9 @@ class FableServiceProviderBase
 					: `${this.UUID}`;
 	}
 
+	/**
+	 * @param {import('fable')} pFable
+	 */
 	connectFable(pFable)
 	{
 		if ((typeof(pFable) !== 'object') || (!pFable.isFable))
@@ -86,4 +109,4 @@ class FableServiceProviderBase
 module.exports = FableServiceProviderBase;
 
 // This is left here in case we want to go back to having different code/base class for "core" services
-module.exports.CoreServiceProviderBase = FableServiceProviderBase;
+module.exports.CoreServiceProviderBase = FableServiceProviderBase;

package/test/FableServiceProvider_tests.js

@@ -9,11 +9,16 @@
 const libFable = require('fable');
 const libFableServiceProviderBase = require('../source/Fable-ServiceProviderBase.js');
 
-const Chai = require("chai");
+const Chai = require('chai');
 const Expect = Chai.expect;
 
 class SimpleService extends libFableServiceProviderBase
 {
+    /**
+	 * @param {import('fable')|Record<string, any>} pFable - The fable instance, or the options object if there is no fable
+	 * @param {Record<string, any>|string} [pOptions] - (optional) The options object, or the service hash if there is no fable
+	 * @param {string} [pServiceHash] - (optional) The service hash to identify this service instance
+     */
     constructor(pFable, pOptions, pServiceHash)
     {
         super(pFable, pOptions, pServiceHash);
@@ -29,6 +34,11 @@ class SimpleService extends libFableServiceProviderBase
 
 class MockDatabaseService extends libFableServiceProviderBase
 {
+    /**
+	 * @param {import('fable')|Record<string, any>} pFable - The fable instance, or the options object if there is no fable
+	 * @param {Record<string, any>|string} [pOptions] - (optional) The options object, or the service hash if there is no fable
+	 * @param {string} [pServiceHash] - (optional) The service hash to identify this service instance
+     */
     constructor(pFable, pOptions, pServiceHash)
     {
         super(pFable, pOptions, pServiceHash);
@@ -49,6 +59,10 @@ class MockDatabaseService extends libFableServiceProviderBase
 
 class MockCoreService extends libFableServiceProviderBase.CoreServiceProviderBase
 {
+    /**
+	 * @param {Record<string, any>|string} [pOptions] - (optional) The options object, or the service hash if there is no fable
+	 * @param {string} [pServiceHash] - (optional) The service hash to identify this service instance
+     */
     constructor(pOptions, pServiceHash)
     {
         super(pOptions, pServiceHash);
@@ -68,6 +82,7 @@ suite
 	'Fable Service Manager',
 	function()
 	{
+        /** @type {import('fable')} */
 		var testFable = false;
 
 		setup
@@ -295,4 +310,4 @@ suite
 			}
 		);
 	}
-);
+);

package/tsconfig.build.json

@@ -0,0 +1,15 @@
+{
+	"include": ["source"],
+	"compilerOptions":
+	{
+		"lib": ["es5", "es6", "dom"],
+		"module": "commonjs",
+		"allowJs": true,
+		"checkJs": true,
+		"declaration": true,
+		"emitDeclarationOnly": true,
+		"outDir": "types",
+		"declarationMap": true,
+		"resolveJsonModule": true
+	}
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+	"include": ["source", "test"],
+	"compilerOptions":
+	{
+		"lib": ["es5", "es6", "dom"],
+		"module": "commonjs",
+		"allowJs": true,
+		"checkJs": true,
+		"declaration": true,
+		"emitDeclarationOnly": true,
+		"outDir": "types",
+		"declarationMap": true,
+		"resolveJsonModule": true
+	}
+}

package/types/source/Fable-ServiceProviderBase.d.ts

@@ -0,0 +1,37 @@
+export = FableServiceProviderBase;
+declare class FableServiceProviderBase {
+    static isFableService: boolean;
+    /**
+     * The constructor can be used in two ways:
+     * 1) With a fable, options object and service hash (the options object and service hash are optional)a
+     * 2) With an object or nothing as the first parameter, where it will be treated as the options object
+     *
+     * @param {import('fable')|Record<string, any>} [pFable] - (optional) The fable instance, or the options object if there is no fable
+     * @param {Record<string, any>|string} [pOptions] - (optional) The options object, or the service hash if there is no fable
+     * @param {string} [pServiceHash] - (optional) The service hash to identify this service instance
+     */
+    constructor(pFable?: any | Record<string, any>, pOptions?: Record<string, any> | string, pServiceHash?: string);
+    /** @type {import('fable')} */
+    fable: any;
+    /** @type {string} */
+    UUID: string;
+    /** @type {Record<string, any>} */
+    options: Record<string, any>;
+    /** @type {Record<string, any>} */
+    services: Record<string, any>;
+    /** @type {Record<string, any>} */
+    servicesMap: Record<string, any>;
+    /** @type {Record<string, any>} */
+    _PackageFableServiceProvider: Record<string, any>;
+    serviceType: string;
+    Hash: string;
+    /**
+     * @param {import('fable')} pFable
+     */
+    connectFable(pFable: any): true | Error;
+    log: any;
+}
+declare namespace FableServiceProviderBase {
+    export { FableServiceProviderBase as CoreServiceProviderBase };
+}
+//# sourceMappingURL=Fable-ServiceProviderBase.d.ts.map

package/types/source/Fable-ServiceProviderBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Fable-ServiceProviderBase.d.ts","sourceRoot":"","sources":["../../source/Fable-ServiceProviderBase.js"],"names":[],"mappings":";AAOA;IAkGC,+BAA6B;IAhG7B;;;;;;;;OAQG;IACH,qBAJW,GAAe,GAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,aACnC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAC,MAAM,iBAC1B,MAAM,EAqDhB;IAjDA,8BAA8B;IAC9B,WAAU;IACV,qBAAqB;IACrB,MADW,MAAM,CACR;IACT,kCAAkC;IAClC,SADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAClB;IACZ,kCAAkC;IAClC,UADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACjB;IACb,kCAAkC;IAClC,aADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACd;IAahB,kCAAkC;IAClC,8BADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACgB;IAoB9C,oBAAyC;IAGzC,aAEmB;IAGpB;;OAEG;IACH,wCA6BC;IAbC,SAA6B;CAgB/B"}