@jonloucks/contracts-ts 1.0.1 → 1.0.2

package/api/Convenience.d.ts

@@ -0,0 +1,87 @@
+import { AutoClose, Contract, OptionalType, RequiredType } from "@jonloucks/contracts-ts";
+import { PromisorType } from "@jonloucks/contracts-ts/api/Promisor";
+import { BindStrategyType } from "@jonloucks/contracts-ts/api/BindStrategy";
+import { Promisor } from "@jonloucks/contracts-ts/api/Promisor";
+import { TransformType } from "@jonloucks/contracts-ts/api/Types";
+/**
+ * @module Convenience
+ * @description
+ *
+ * This module provides convenience functions for creating  types
+ * using the shared global CONTRACTS instance. For performance-sensitive
+ * applications, consider using factory instances directly to avoid the
+ * overhead of enforcing the factory contract on each creation.
+ *
+ * Internal Note: To avoid circular dependencies, other modules should not
+ * import from this module. Instead, they should import directly from the
+ * source modules of the types.
+ */
+/**
+ * Claim a deliverable from a Contract via the shared global CONTRACTS instance.
+ *
+ * @param contract the Contract to claim from
+ * @returns the deliverable
+ */
+export declare function claim<T>(contract: RequiredType<Contract<T>>): OptionalType<T>;
+/**
+ * Enforce a deliverable from a Contract via the shared global CONTRACTS instance.
+ *
+ * @param contract the Contract to enforce from
+ * @returns the deliverable
+ */
+export declare function enforce<T>(contract: RequiredType<Contract<T>>): RequiredType<T>;
+/**
+ * Bind a Promisor to a Contract via the shared global CONTRACTS instance.
+ *
+ * @param contract the Contract to bind to
+ * @param promisor the PromisorType to bind
+ * @param bindStrategy optional BindStrategyType
+ * @returns an AutoClose to manage the binding lifecycle
+ */
+export declare function bind<T>(contract: RequiredType<Contract<T>>, promisor: PromisorType<T>, bindStrategy?: BindStrategyType): RequiredType<AutoClose>;
+/**
+ * Check if a Contract is bound via the shared global CONTRACTS instance.
+ *
+ * @param contract the Contract to check
+ * @returns true if the Contract is bound, false otherwise
+ */
+export declare function isBound<T>(contract: RequiredType<Contract<T>>): boolean;
+/**
+ * Creates a Promisor that returns the given value every time it is claimed.
+ *
+ * @param deliverable the value to return from the Promisor
+ * @return The new Promisor
+ * @param <T> the type of deliverable
+ */
+export declare function createValue<T>(deliverable: OptionalType<T>): RequiredType<Promisor<T>>;
+/**
+ * Creates a Promisor that only calls the source Promisor once and then always
+ * returns that value.
+ * Note: increment and decrementUsage are relayed to the source promisor.
+ *
+ * @param promisor the source Promisor
+ * @return The new Promisor
+ * @param <T> the type of deliverable
+ */
+export declare function createSingleton<T>(promisor: PromisorType<T>): RequiredType<Promisor<T>>;
+/**
+ * Reference counted, lazy loaded, with opt-in 'open' and 'close' invoked on deliverable.
+ * Note: increment and decrementUsage are relayed to the source promisor.
+ *
+ * @param promisor the source promisor
+ * @return the new Promisor
+ * @param <T> the type of deliverable
+ */
+export declare function createLifeCycle<T>(promisor: PromisorType<T>): RequiredType<Promisor<T>>;
+/**
+ * Extract values from the deliverable of a source Promisor.
+ * Note: increment and decrementUsage are relayed to the source promisor.
+ *
+ * @param promisor the source promisor
+ * @param extractor the function that gets an object from the deliverable. For example Person  => Age
+ * @return the new Promisor
+ * @param <T> the type of deliverable
+ * @param <R> the new Promisor deliverable type
+ */
+export declare function createExtractor<T, R>(promisor: PromisorType<T>, extractor: TransformType<T, R>): RequiredType<Promisor<R>>;
+//# sourceMappingURL=Convenience.d.ts.map

package/api/Convenience.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Convenience.d.ts","sourceRoot":"","sources":["../../src/api/Convenience.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAa,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACrG,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAE5E,OAAO,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAElE;;;;;;;;;;;;GAYG;AAEH;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAE/E;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,gBAAgB,GAAG,YAAY,CAAC,SAAS,CAAC,CAEhJ;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAEvE;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAEtF;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAEvF;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAEvF;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAE1H"}

package/api/Convenience.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.claim = claim;
+exports.enforce = enforce;
+exports.bind = bind;
+exports.isBound = isBound;
+exports.createValue = createValue;
+exports.createSingleton = createSingleton;
+exports.createLifeCycle = createLifeCycle;
+exports.createExtractor = createExtractor;
+const contracts_ts_1 = require("@jonloucks/contracts-ts");
+const PromisorFactory_1 = require("@jonloucks/contracts-ts/api/PromisorFactory");
+/**
+ * @module Convenience
+ * @description
+ *
+ * This module provides convenience functions for creating  types
+ * using the shared global CONTRACTS instance. For performance-sensitive
+ * applications, consider using factory instances directly to avoid the
+ * overhead of enforcing the factory contract on each creation.
+ *
+ * Internal Note: To avoid circular dependencies, other modules should not
+ * import from this module. Instead, they should import directly from the
+ * source modules of the types.
+ */
+/**
+ * Claim a deliverable from a Contract via the shared global CONTRACTS instance.
+ *
+ * @param contract the Contract to claim from
+ * @returns the deliverable
+ */
+function claim(contract) {
+    return contracts_ts_1.CONTRACTS.claim(contract);
+}
+/**
+ * Enforce a deliverable from a Contract via the shared global CONTRACTS instance.
+ *
+ * @param contract the Contract to enforce from
+ * @returns the deliverable
+ */
+function enforce(contract) {
+    return contracts_ts_1.CONTRACTS.enforce(contract);
+}
+/**
+ * Bind a Promisor to a Contract via the shared global CONTRACTS instance.
+ *
+ * @param contract the Contract to bind to
+ * @param promisor the PromisorType to bind
+ * @param bindStrategy optional BindStrategyType
+ * @returns an AutoClose to manage the binding lifecycle
+ */
+function bind(contract, promisor, bindStrategy) {
+    return contracts_ts_1.CONTRACTS.bind(contract, promisor, bindStrategy);
+}
+/**
+ * Check if a Contract is bound via the shared global CONTRACTS instance.
+ *
+ * @param contract the Contract to check
+ * @returns true if the Contract is bound, false otherwise
+ */
+function isBound(contract) {
+    return contracts_ts_1.CONTRACTS.isBound(contract);
+}
+/**
+ * Creates a Promisor that returns the given value every time it is claimed.
+ *
+ * @param deliverable the value to return from the Promisor
+ * @return The new Promisor
+ * @param <T> the type of deliverable
+ */
+function createValue(deliverable) {
+    return enforce(PromisorFactory_1.CONTRACT).createValue(deliverable);
+}
+/**
+ * Creates a Promisor that only calls the source Promisor once and then always
+ * returns that value.
+ * Note: increment and decrementUsage are relayed to the source promisor.
+ *
+ * @param promisor the source Promisor
+ * @return The new Promisor
+ * @param <T> the type of deliverable
+ */
+function createSingleton(promisor) {
+    return enforce(PromisorFactory_1.CONTRACT).createSingleton(promisor);
+}
+/**
+ * Reference counted, lazy loaded, with opt-in 'open' and 'close' invoked on deliverable.
+ * Note: increment and decrementUsage are relayed to the source promisor.
+ *
+ * @param promisor the source promisor
+ * @return the new Promisor
+ * @param <T> the type of deliverable
+ */
+function createLifeCycle(promisor) {
+    return enforce(PromisorFactory_1.CONTRACT).createLifeCycle(promisor);
+}
+/**
+ * Extract values from the deliverable of a source Promisor.
+ * Note: increment and decrementUsage are relayed to the source promisor.
+ *
+ * @param promisor the source promisor
+ * @param extractor the function that gets an object from the deliverable. For example Person  => Age
+ * @return the new Promisor
+ * @param <T> the type of deliverable
+ * @param <R> the new Promisor deliverable type
+ */
+function createExtractor(promisor, extractor) {
+    return enforce(PromisorFactory_1.CONTRACT).createExtractor(promisor, extractor);
+}
+//# sourceMappingURL=Convenience.js.map

package/api/Convenience.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Convenience.js","sourceRoot":"","sources":["../../src/api/Convenience.ts"],"names":[],"mappings":";;AA2BA,sBAEC;AAQD,0BAEC;AAUD,oBAEC;AAQD,0BAEC;AASD,kCAEC;AAWD,0CAEC;AAUD,0CAEC;AAYD,0CAEC;AA/GD,0DAAqG;AAGrG,iFAA2F;AAI3F;;;;;;;;;;;;GAYG;AAEH;;;;;GAKG;AACH,SAAgB,KAAK,CAAI,QAAmC;IAC1D,OAAO,wBAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,OAAO,CAAI,QAAmC;IAC5D,OAAO,wBAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAAI,QAAmC,EAAE,QAAyB,EAAE,YAA+B;IACrH,OAAO,wBAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,SAAgB,OAAO,CAAI,QAAmC;IAC5D,OAAO,wBAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAI,WAA4B;IACzD,OAAO,OAAO,CAAC,0BAAgB,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAAI,QAAyB;IAC1D,OAAO,OAAO,CAAC,0BAAgB,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAI,QAAyB;IAC1D,OAAO,OAAO,CAAC,0BAAgB,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAAO,QAAyB,EAAE,SAA8B;IAC7F,OAAO,OAAO,CAAC,0BAAgB,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AACxE,CAAC"}

package/api/PromisorFactory.d.ts

@@ -33,7 +33,7 @@ export interface PromisorFactory {
      */
     createLifeCycle<T>(promisor: PromisorType<T>): RequiredType<Promisor<T>>;
     /**
-     * Extract
+     * Extract values from the deliverable of a source Promisor.
      * Note: increment and decrementUsage are relayed to the source promisor.
      *
      * @param promisor the source promisor

package/auxiliary/Convenience.d.ts

@@ -0,0 +1,42 @@
+import { RequiredType } from "@jonloucks/contracts-ts/api/Types";
+import { AtomicBoolean } from "@jonloucks/contracts-ts/auxiliary/AtomicBoolean";
+import { AtomicReference } from "@jonloucks/contracts-ts/auxiliary/AtomicReference";
+import { AtomicInteger } from "@jonloucks/contracts-ts/auxiliary/AtomicInteger";
+export { AtomicBoolean } from "@jonloucks/contracts-ts/auxiliary/AtomicBoolean";
+export { AtomicReference } from "@jonloucks/contracts-ts/auxiliary/AtomicReference";
+export { AtomicInteger } from "@jonloucks/contracts-ts/auxiliary/AtomicInteger";
+/**
+ * @module Convenience
+ * @description
+ *
+ * This module provides convenience functions for creating auxiliary types
+ * using the shared global CONTRACTS instance. For performance-sensitive
+ * applications, consider using factory instances directly to avoid the
+ * overhead of enforcing the factory contract on each creation.
+ *
+ * Internal Note: To avoid circular dependencies, other modules should not
+ * import from this module. Instead, they should import directly from the
+ * source modules of the auxiliary types.
+ */
+/**
+ * Create an AtomicBoolean via the shared global CONTRACTS instance.
+ *
+ * @param initialValue the initial boolean value
+ * @returns the AtomicBoolean instance
+ */
+export declare function createAtomicBoolean(initialValue: boolean): RequiredType<AtomicBoolean>;
+/**
+ * Create an AtomicReference via the shared global CONTRACTS instance.
+ *
+ * @param initialValue the initial reference value
+ * @returns the AtomicReference instance
+ */
+export declare function createAtomicReference<T>(initialValue: T): RequiredType<AtomicReference<T>>;
+/**
+ * Create an AtomicInteger via the shared global CONTRACTS instance.
+ *
+ * @param initialValue the initial integer value
+ * @returns the AtomicInteger instance
+ */
+export declare function createAtomicInteger(initialValue: number): RequiredType<AtomicInteger>;
+//# sourceMappingURL=Convenience.d.ts.map

package/auxiliary/Convenience.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Convenience.d.ts","sourceRoot":"","sources":["../../src/auxiliary/Convenience.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAKjE,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,mDAAmD,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAEhF,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,mDAAmD,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAEhF;;;;;;;;;;;;GAYG;AAEH;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC,CAEtF;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAE1F;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY,CAAC,aAAa,CAAC,CAErF"}

package/auxiliary/Convenience.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAtomicBoolean = createAtomicBoolean;
+exports.createAtomicReference = createAtomicReference;
+exports.createAtomicInteger = createAtomicInteger;
+const contracts_ts_1 = require("@jonloucks/contracts-ts");
+const AtomicBooleanFactory_1 = require("@jonloucks/contracts-ts/auxiliary/AtomicBooleanFactory");
+const AtomicReferenceFactory_1 = require("@jonloucks/contracts-ts/auxiliary/AtomicReferenceFactory");
+const AtomicIntegerFactory_1 = require("@jonloucks/contracts-ts/auxiliary/AtomicIntegerFactory");
+/**
+ * @module Convenience
+ * @description
+ *
+ * This module provides convenience functions for creating auxiliary types
+ * using the shared global CONTRACTS instance. For performance-sensitive
+ * applications, consider using factory instances directly to avoid the
+ * overhead of enforcing the factory contract on each creation.
+ *
+ * Internal Note: To avoid circular dependencies, other modules should not
+ * import from this module. Instead, they should import directly from the
+ * source modules of the auxiliary types.
+ */
+/**
+ * Create an AtomicBoolean via the shared global CONTRACTS instance.
+ *
+ * @param initialValue the initial boolean value
+ * @returns the AtomicBoolean instance
+ */
+function createAtomicBoolean(initialValue) {
+    return contracts_ts_1.CONTRACTS.enforce(AtomicBooleanFactory_1.CONTRACT).createAtomicBoolean(initialValue);
+}
+/**
+ * Create an AtomicReference via the shared global CONTRACTS instance.
+ *
+ * @param initialValue the initial reference value
+ * @returns the AtomicReference instance
+ */
+function createAtomicReference(initialValue) {
+    return contracts_ts_1.CONTRACTS.enforce(AtomicReferenceFactory_1.CONTRACT).createAtomicReference(initialValue);
+}
+/**
+ * Create an AtomicInteger via the shared global CONTRACTS instance.
+ *
+ * @param initialValue the initial integer value
+ * @returns the AtomicInteger instance
+ */
+function createAtomicInteger(initialValue) {
+    return contracts_ts_1.CONTRACTS.enforce(AtomicIntegerFactory_1.CONTRACT).createAtomicInteger(initialValue);
+}
+//# sourceMappingURL=Convenience.js.map

package/auxiliary/Convenience.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Convenience.js","sourceRoot":"","sources":["../../src/auxiliary/Convenience.ts"],"names":[],"mappings":";;AAiCA,kDAEC;AAQD,sDAEC;AAQD,kDAEC;AAtDD,0DAAoD;AACpD,iGAAqG;AACrG,qGAAyG;AACzG,iGAAqG;AASrG;;;;;;;;;;;;GAYG;AAEH;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,YAAqB;IACvD,OAAO,wBAAS,CAAC,OAAO,CAAC,+BAAe,CAAC,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAI,YAAe;IACtD,OAAO,wBAAS,CAAC,OAAO,CAAC,iCAAiB,CAAC,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAClF,CAAC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,YAAoB;IACtD,OAAO,wBAAS,CAAC,OAAO,CAAC,+BAAe,CAAC,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;AAC9E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jonloucks/contracts-ts",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Typescript Dependency Contracts for dependency inversion",
   "main": "index.js",
   "types": "index.d.ts",

package/version.js

@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = exports.NAME = void 0;
 // generated file - do not edit
 exports.NAME = "@jonloucks/contracts-ts";
-exports.VERSION = "1.0.1";
+exports.VERSION = "1.0.2";
 //# sourceMappingURL=version.js.map