gingersnap 0.23.3 → 0.23.5

package/README.md

@@ -0,0 +1,25 @@
+## GingerSnap
+
+
+## Description
+Gingersnap is a general purpose library built with the aim of filling the gaps of javascript shortcomings. First-Class support for networking, IO operations and data validation is at the core of this library.
+
+## Installation
+To install the package, run `npm install gingersnap`
+
+## Roadmap
+- Support request timeout
+- Opt out of using an authenticator for a method's request
+- Support multiple authenticators, and setting Primary authenticator
+- Allow methods to choose authenticator
+- Support endpoint polling with subscription methods
+- Support offline mode with resume feature once net is back
+- Support default response when offline
+- Support grouping requests, if one fail cancel all
+- Support race requests, the first one that finishes/fails cancel all others and return the response
+- Plugin support for services
+- Support for NodeJs
+- Push message support via subscribers
+- Websocket support via subscribers, and methods for sending messages
+- Websocket auth support
+- Improved documentation

package/data/AtomicValue.cjs

@@ -0,0 +1,66 @@
+'use strict';
+
+var _tslib = require('../_virtual/_tslib.cjs');
+var future = require('../future/future.cjs');
+require('ramda');
+var synchronize = require('../synchronize.cjs');
+var stream = require('../stream.cjs');
+var stream_state = require('../stream/state.cjs');
+var ValueDestroyedError = require('../errors/ValueDestroyedError.cjs');
+
+class AtomicValue {
+    constructor() {
+        this.setEvt = new synchronize.FutureEvent();
+        this.setLock = new synchronize.Lock();
+        this.closed = false;
+    }
+    set(value) {
+        return this.setLock.with(() => _tslib.__awaiter(this, void 0, void 0, function* () {
+            if (this.closed) {
+                throw new ValueDestroyedError.ValueDestroyedError();
+            }
+            this.value = value;
+            this.setEvt.set();
+        }));
+    }
+    get() {
+        return this.read(false);
+    }
+    pop() {
+        return this.read(true);
+    }
+    destroy() {
+        this.closed = true;
+    }
+    get stream() {
+        return new stream.Stream((signal) => this.pop()
+            .catch((error) => {
+            if (error instanceof ValueDestroyedError.ValueDestroyedError) {
+                return new stream_state.ExecutorState(true);
+            }
+            throw error;
+        })
+            .registerSignal(signal));
+    }
+    read(removeValue) {
+        return future.Future.of((resolve, reject, signal) => _tslib.__awaiter(this, void 0, void 0, function* () {
+            while (this.value === undefined && !this.closed) {
+                this.setEvt.clear();
+                yield this.setEvt.wait().registerSignal(signal);
+            }
+            if (this.closed && this.value === undefined) {
+                return reject(new ValueDestroyedError.ValueDestroyedError());
+            }
+            const value = this.value;
+            if (removeValue) {
+                this.value = undefined;
+            }
+            resolve(value);
+            if (this.closed) {
+                return reject(new ValueDestroyedError.ValueDestroyedError());
+            }
+        }));
+    }
+}
+
+exports.AtomicValue = AtomicValue;

package/data/AtomicValue.mjs

@@ -0,0 +1,64 @@
+import { __awaiter } from '../_virtual/_tslib.mjs';
+import { Future } from '../future/future.mjs';
+import 'ramda';
+import { FutureEvent, Lock } from '../synchronize.mjs';
+import { Stream } from '../stream.mjs';
+import { ExecutorState } from '../stream/state.mjs';
+import { ValueDestroyedError } from '../errors/ValueDestroyedError.mjs';
+
+class AtomicValue {
+    constructor() {
+        this.setEvt = new FutureEvent();
+        this.setLock = new Lock();
+        this.closed = false;
+    }
+    set(value) {
+        return this.setLock.with(() => __awaiter(this, void 0, void 0, function* () {
+            if (this.closed) {
+                throw new ValueDestroyedError();
+            }
+            this.value = value;
+            this.setEvt.set();
+        }));
+    }
+    get() {
+        return this.read(false);
+    }
+    pop() {
+        return this.read(true);
+    }
+    destroy() {
+        this.closed = true;
+    }
+    get stream() {
+        return new Stream((signal) => this.pop()
+            .catch((error) => {
+            if (error instanceof ValueDestroyedError) {
+                return new ExecutorState(true);
+            }
+            throw error;
+        })
+            .registerSignal(signal));
+    }
+    read(removeValue) {
+        return Future.of((resolve, reject, signal) => __awaiter(this, void 0, void 0, function* () {
+            while (this.value === undefined && !this.closed) {
+                this.setEvt.clear();
+                yield this.setEvt.wait().registerSignal(signal);
+            }
+            if (this.closed && this.value === undefined) {
+                return reject(new ValueDestroyedError());
+            }
+            const value = this.value;
+            if (removeValue) {
+                this.value = undefined;
+            }
+            resolve(value);
+            if (this.closed) {
+                return reject(new ValueDestroyedError());
+            }
+        }));
+    }
+}
+
+export { AtomicValue };

package/data/store.cjs

@@ -0,0 +1,12 @@
+'use strict';
+
+var manager = require('./store/manager.cjs');
+var web = require('./store/web.cjs');
+var json = require('./store/json.cjs');
+
+
+
+exports.CacheManager = manager.CacheManager;
+exports.LocalWebStore = web.LocalWebStore;
+exports.SessionWebStore = web.SessionWebStore;
+exports.JSONFileStore = json.JSONFileStore;

package/data/store.mjs

@@ -0,0 +1,3 @@
+export { CacheManager } from './store/manager.mjs';
+export { LocalWebStore, SessionWebStore } from './store/web.mjs';
+export { JSONFileStore } from './store/json.mjs';

package/data-structures/object/Publisher.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+class Publisher {
+    constructor(queue, transformer) {
+        this.queue = queue;
+        this.transformer = transformer;
+    }
+    send(value) {
+        this.queue.enqueue(this.transformer(value));
+    }
+    publish(value) {
+        this.send(value);
+    }
+}
+
+exports.Publisher = Publisher;

package/data-structures/object/Publisher.d.ts

@@ -0,0 +1,8 @@
+import { Queue } from "./Queue";
+export declare class Publisher<T, K> {
+    private readonly queue;
+    private readonly transformer;
+    constructor(queue: Queue<T>, transformer: (v: K) => T);
+    send(value: K): void;
+    publish(value: K): void;
+}

package/data-structures/object/Publisher.mjs

@@ -0,0 +1,14 @@
+class Publisher {
+    constructor(queue, transformer) {
+        this.queue = queue;
+        this.transformer = transformer;
+    }
+    send(value) {
+        this.queue.enqueue(this.transformer(value));
+    }
+    publish(value) {
+        this.send(value);
+    }
+}
+
+export { Publisher };

package/data-structures/object/Queue.cjs

@@ -9,6 +9,7 @@ var synchronize = require('../../synchronize.cjs');
 var stream = require('../../stream.cjs');
 var QueueFullError = require('../../errors/QueueFullError.cjs');
 var ValueDestroyedError = require('../../errors/ValueDestroyedError.cjs');
+var Publisher = require('./Publisher.cjs');
 
 /**
  * Queue data structure for First In First Out operation (FIFO)
@@ -25,6 +26,9 @@ class Queue extends WatchableObject.WatchableObject {
     get streamEntries() {
         return stream.Stream.of(this.asyncIterator);
     }
+    createPublisher(transformer) {
+        return new Publisher.Publisher(this, transformer);
+    }
     close() {
         this.closed = true;
         this.closedSignal.dispatchEvent(new CustomEvent("abort"));

package/data-structures/object/Queue.d.ts

@@ -1,6 +1,7 @@
 import { WatchableObject } from "./WatchableObject";
 import { Future, WaitPeriod } from "../../future";
 import { Stream } from "../../stream";
+import { Publisher } from "./Publisher";
 /**
  * Queue data structure for First In First Out operation (FIFO)
  */
@@ -12,6 +13,7 @@ export declare class Queue<T> extends WatchableObject<number, T> implements Iter
     private readonly dequeueEvt;
     constructor(objectMaxSize?: number, expiryPeriod?: WaitPeriod);
     get streamEntries(): Stream<T>;
+    createPublisher<K>(transformer: (v: K) => T): Publisher<T, K>;
     close(): void;
     clone(): Queue<T>;
     ingest(stream: Stream<T>): Future<void>;

package/data-structures/object/Queue.mjs

@@ -7,6 +7,7 @@ import { FutureEvent } from '../../synchronize.mjs';
 import { Stream } from '../../stream.mjs';
 import { QueueFullError } from '../../errors/QueueFullError.mjs';
 import { ValueDestroyedError } from '../../errors/ValueDestroyedError.mjs';
+import { Publisher } from './Publisher.mjs';
 
 /**
  * Queue data structure for First In First Out operation (FIFO)
@@ -23,6 +24,9 @@ class Queue extends WatchableObject {
     get streamEntries() {
         return Stream.of(this.asyncIterator);
     }
+    createPublisher(transformer) {
+        return new Publisher(this, transformer);
+    }
     close() {
         this.closed = true;
         this.closedSignal.dispatchEvent(new CustomEvent("abort"));

package/package.json

@@ -1 +1 @@
-{"name":"gingersnap","version":"0.23.3","description":"A general purpose library built with the aim of filling the gaps of javascript shortcomings","dependencies":{"@msgpack/msgpack":"^3.0.0-beta2","browser-or-node":"^3.0.0-pre.0","modern-isomorphic-ws":"^1.0.5","object-hash":"^3.0.0","papaparse":"^5.4.1","protobufjs":"^7.2.6","ramda":"^0.30.1","reflect-metadata":"^0.2.2","tslib":"^2.6.3","uuid":"^9.0.1","ws":"^8.16.0","x2js":"^3.4.4"},"author":"CookieNerds LLC","exports":{"./synchronize":{"import":{"types":"./synchronize.d.ts","default":"./synchronize.mjs"},"require":{"types":"./synchronize.d.ts","default":"./synchronize.cjs"}},"./mocks":{"import":{"types":"./mocks.d.ts","default":"./mocks.mjs"},"require":{"types":"./mocks.d.ts","default":"./mocks.cjs"}},"./socket":{"import":{"types":"./socket.d.ts","default":"./socket.mjs"},"require":{"types":"./socket.d.ts","default":"./socket.cjs"}},"./typing":{"import":{"types":"./typing.d.ts","default":"./typing.mjs"},"require":{"types":"./typing.d.ts","default":"./typing.cjs"}},"./stream":{"import":{"types":"./stream/index.d.ts","default":"./stream.mjs"},"require":{"types":"./stream/index.d.ts","default":"./stream.cjs"}},"./reflection/injector":{"import":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.mjs"},"require":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.cjs"}},"./stream/call":{"import":{"types":"./stream/call.d.ts","default":"./stream/call.mjs"},"require":{"types":"./stream/call.d.ts","default":"./stream/call.cjs"}},"./stream/state":{"import":{"types":"./stream/state.d.ts","default":"./stream/state.mjs"},"require":{"types":"./stream/state.d.ts","default":"./stream/state.cjs"}},"./stream/collector":{"import":{"types":"./stream/collector.d.ts","default":"./stream/collector.mjs"},"require":{"types":"./stream/collector.d.ts","default":"./stream/collector.cjs"}},"./stream/observable":{"import":{"types":"./stream/observable.d.ts","default":"./stream/observable.mjs"},"require":{"types":"./stream/observable.d.ts","default":"./stream/observable.cjs"}},"./networking":{"import":{"types":"./networking/index.d.ts","default":"./networking.mjs"},"require":{"types":"./networking/index.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers/index.d.ts","default":"./managers.mjs"},"require":{"types":"./managers/index.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future/index.d.ts","default":"./future.mjs"},"require":{"types":"./future/index.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors/index.d.ts","default":"./errors.mjs"},"require":{"types":"./errors/index.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model/index.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model/index.d.ts","default":"./data/model.cjs"}},"./data/bus":{"import":{"types":"./data/bus.d.ts","default":"./data/bus.mjs"},"require":{"types":"./data/bus.d.ts","default":"./data/bus.cjs"}},"./data/value":{"import":{"types":"./data/value.d.ts","default":"./data/value.mjs"},"require":{"types":"./data/value.d.ts","default":"./data/value.cjs"}},"./store":{"import":{"types":"./store/index.d.ts","default":"./store.mjs"},"require":{"types":"./store/index.d.ts","default":"./store.cjs"}},"./functools":{"import":{"types":"./functools/index.d.ts","default":"./functools.mjs"},"require":{"types":"./functools/index.d.ts","default":"./functools.cjs"}}}}
+{"name":"gingersnap","version":"0.23.5","description":"A general purpose library built with the aim of filling the gaps of javascript shortcomings","dependencies":{"@msgpack/msgpack":"^3.0.0-beta2","browser-or-node":"^3.0.0-pre.0","modern-isomorphic-ws":"^1.0.5","object-hash":"^3.0.0","papaparse":"^5.4.1","protobufjs":"^7.2.6","ramda":"^0.30.1","reflect-metadata":"^0.2.2","tslib":"^2.6.3","uuid":"^9.0.1","ws":"^8.16.0","x2js":"^3.4.4"},"author":"CookieNerds LLC","exports":{"./synchronize":{"import":{"types":"./synchronize.d.ts","default":"./synchronize.mjs"},"require":{"types":"./synchronize.d.ts","default":"./synchronize.cjs"}},"./mocks":{"import":{"types":"./mocks.d.ts","default":"./mocks.mjs"},"require":{"types":"./mocks.d.ts","default":"./mocks.cjs"}},"./socket":{"import":{"types":"./socket.d.ts","default":"./socket.mjs"},"require":{"types":"./socket.d.ts","default":"./socket.cjs"}},"./typing":{"import":{"types":"./typing.d.ts","default":"./typing.mjs"},"require":{"types":"./typing.d.ts","default":"./typing.cjs"}},"./stream":{"import":{"types":"./stream/index.d.ts","default":"./stream.mjs"},"require":{"types":"./stream/index.d.ts","default":"./stream.cjs"}},"./reflection/injector":{"import":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.mjs"},"require":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.cjs"}},"./stream/call":{"import":{"types":"./stream/call.d.ts","default":"./stream/call.mjs"},"require":{"types":"./stream/call.d.ts","default":"./stream/call.cjs"}},"./stream/state":{"import":{"types":"./stream/state.d.ts","default":"./stream/state.mjs"},"require":{"types":"./stream/state.d.ts","default":"./stream/state.cjs"}},"./stream/collector":{"import":{"types":"./stream/collector.d.ts","default":"./stream/collector.mjs"},"require":{"types":"./stream/collector.d.ts","default":"./stream/collector.cjs"}},"./stream/observable":{"import":{"types":"./stream/observable.d.ts","default":"./stream/observable.mjs"},"require":{"types":"./stream/observable.d.ts","default":"./stream/observable.cjs"}},"./networking":{"import":{"types":"./networking/index.d.ts","default":"./networking.mjs"},"require":{"types":"./networking/index.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers/index.d.ts","default":"./managers.mjs"},"require":{"types":"./managers/index.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future/index.d.ts","default":"./future.mjs"},"require":{"types":"./future/index.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors/index.d.ts","default":"./errors.mjs"},"require":{"types":"./errors/index.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model/index.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model/index.d.ts","default":"./data/model.cjs"}},"./data/bus":{"import":{"types":"./data/bus.d.ts","default":"./data/bus.mjs"},"require":{"types":"./data/bus.d.ts","default":"./data/bus.cjs"}},"./data/AtomicValue":{"import":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.mjs"},"require":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.cjs"}},"./data/store":{"import":{"types":"./data/store/index.d.ts","default":"./data/store.mjs"},"require":{"types":"./data/store/index.d.ts","default":"./data/store.cjs"}},"./functools":{"import":{"types":"./functools/index.d.ts","default":"./functools.mjs"},"require":{"types":"./functools/index.d.ts","default":"./functools.cjs"}}}}

package/stream.cjs

@@ -15,7 +15,7 @@ var IllegalOperationError = require('./errors/IllegalOperationError.cjs');
 require('./data-structures/object/WatchableObject.cjs');
 require('uuid');
 var Queue = require('./data-structures/object/Queue.cjs');
-var data_value = require('./data/value.cjs');
+var data_AtomicValue = require('./data/AtomicValue.cjs');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);
@@ -769,7 +769,7 @@ class Stream {
      */
     conflate() {
         return Stream.seed(() => {
-            const value = new data_value.AtomicValue();
+            const value = new data_AtomicValue.AtomicValue();
             this.forEach((record) => value.set(record))
                 .finally(() => value.destroy())
                 .schedule();

package/stream.mjs

@@ -13,7 +13,7 @@ import { IllegalOperationError } from './errors/IllegalOperationError.mjs';
 import './data-structures/object/WatchableObject.mjs';
 import 'uuid';
 import { Queue } from './data-structures/object/Queue.mjs';
-import { AtomicValue } from './data/value.mjs';
+import { AtomicValue } from './data/AtomicValue.mjs';
 
 var ActionType;
 (function (ActionType) {