@quenty/rx 4.1.1-canary.256.edbbcfc.0 → 5.0.0

package/CHANGELOG.md

@@ -3,7 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [4.1.1-canary.256.edbbcfc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rx@4.1.0...@quenty/rx@4.1.1-canary.256.edbbcfc.0) (2022-03-27)
+# [5.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rx@4.2.0...@quenty/rx@5.0.0) (2022-05-21)
+
+
+### Features
+
+* Add ObservableSubscriptionTable ([43152b8](https://github.com/Quenty/NevermoreEngine/commit/43152b876dda2f752c457eef8932bed27170ac9a))
+* Add Rx.skip(toSkip) and make promises autocancel ([69e13f6](https://github.com/Quenty/NevermoreEngine/commit/69e13f6f368f238e64868eecd358f6a6aff76e02))
+* Add Subscription:Disconnect() ([89d1218](https://github.com/Quenty/NevermoreEngine/commit/89d1218c8c7b5d5988d272561c2011df0e58a75c))
+
+
+
+
+
+# [4.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rx@4.1.0...@quenty/rx@4.2.0) (2022-03-27)
 
 
 ### Features

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2021 Quenty
+Copyright (c) 2014-2022 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rx",
-  "version": "4.1.1-canary.256.edbbcfc.0",
+  "version": "5.0.0",
   "description": "Quenty's reactive library for Roblox",
   "keywords": [
     "Roblox",
@@ -27,17 +27,18 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/cancellabledelay": "3.1.1-canary.256.edbbcfc.0",
-    "@quenty/loader": "4.0.1-canary.256.edbbcfc.0",
-    "@quenty/maid": "2.2.1-canary.256.edbbcfc.0",
-    "@quenty/promise": "4.1.1-canary.256.edbbcfc.0",
-    "@quenty/signal": "2.1.1-canary.256.edbbcfc.0",
-    "@quenty/symbol": "2.0.2-canary.256.edbbcfc.0",
-    "@quenty/table": "2.1.2-canary.256.edbbcfc.0",
-    "@quenty/throttle": "4.0.1-canary.256.edbbcfc.0"
+    "@quenty/cancellabledelay": "^3.2.0",
+    "@quenty/canceltoken": "^5.0.0",
+    "@quenty/loader": "^5.0.0",
+    "@quenty/maid": "^2.3.0",
+    "@quenty/promise": "^5.0.0",
+    "@quenty/signal": "^2.2.0",
+    "@quenty/symbol": "^2.1.0",
+    "@quenty/table": "^3.0.0",
+    "@quenty/throttle": "^5.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "edbbcfc38516772a791d50dc43cd6b304ffc4aff"
+  "gitHead": "9f7eaea7543c33c89d2e32c38491b13f9271f4f7"
 }

package/src/Shared/ObservableSubscriptionTable.lua

@@ -0,0 +1,102 @@
+--[=[
+	This allows the storage of subscriptions for keys, such that something
+	can subscribe onto a key, and events can be invoked onto keys.
+	@class ObservableSubscriptionTable
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Observable = require("Observable")
+
+local ObservableSubscriptionTable = {}
+ObservableSubscriptionTable.ClassName = "ObservableSubscriptionTable"
+ObservableSubscriptionTable.__index = ObservableSubscriptionTable
+
+function ObservableSubscriptionTable.new()
+	local self = setmetatable({}, ObservableSubscriptionTable)
+
+	self._subMap = {} -- { TKey: Subscription<TEmit> }
+
+	return self
+end
+
+--[=[
+	Fires for the current key the given value
+	@param key TKey
+	@param ... TEmit
+]=]
+function ObservableSubscriptionTable:Fire(key, ...)
+	assert(key ~= nil, "Bad key")
+
+	local subs = self._subMap[key]
+	if not subs then
+		return
+	end
+
+	-- Make a copy so we don't have to worry about our last changing
+	for _, sub in pairs(table.clone(subs)) do
+		task.spawn(sub.Fire, sub, ...)
+	end
+end
+
+--[=[
+	Observes for the key
+	@param key TKey
+	@return Observable<TEmit>
+]=]
+function ObservableSubscriptionTable:Observe(key)
+	assert(key ~= nil, "Bad key")
+
+	return Observable.new(function(sub)
+		if not self._subMap[key] then
+			self._subMap[key] = { sub }
+		else
+			table.insert(self._subMap[key], sub)
+		end
+
+		return function()
+			if not self._subMap[key] then
+				return
+			end
+
+			local current = self._subMap[key]
+			local index = table.find(current, sub)
+			if not index then
+				return
+			end
+
+			table.remove(current, index)
+			if #current == 0 then
+				self._subMap[key] = nil
+			end
+
+			-- Complete the subscription
+			if sub:IsPending() then
+				task.spawn(function()
+					sub:Complete()
+				end)
+			end
+		end
+	end)
+end
+
+--[=[
+	Completes all subscriptions and removes them from the list.
+]=]
+function ObservableSubscriptionTable:Destroy()
+	while next(self._subMap) do
+		local key, list = next(self._subMap)
+		self._subMap[key] = nil
+
+		for _, sub in pairs(list) do
+			if sub:IsPending() then
+				task.spawn(function()
+					sub:Complete()
+				end)
+			end
+		end
+	end
+end
+
+
+return ObservableSubscriptionTable

package/src/Shared/Rx.lua

@@ -19,6 +19,7 @@ local Symbol = require("Symbol")
 local Table = require("Table")
 local ThrottledFunction = require("ThrottledFunction")
 local cancellableDelay = require("cancellableDelay")
+local CancelToken = require("CancelToken")
 
 local UNSET_VALUE = Symbol.named("unsetValue")
 
@@ -128,18 +129,27 @@ end
 function Rx.toPromise(observable, cancelToken)
 	local maid = Maid.new()
 
-	local promise = Promise.new(function(resolve, reject)
+	local newCancelToken = CancelToken.new(function(cancel)
+		maid:GiveTask(cancel)
 		if cancelToken then
 			if cancelToken:IsCancelled() then
-				reject()
-				return
+				cancel()
+			else
+				maid:GiveTask(cancelToken.Cancelled:Connect(cancel))
 			end
+		end
+	end)
 
-			maid:GiveTask(cancelToken.Cancelled:Connect(function()
-				reject()
-			end))
+	local promise = Promise.new(function(resolve, reject)
+		if newCancelToken:IsCancelled() then
+			reject()
+			return
 		end
 
+		maid:GiveTask(newCancelToken.Cancelled:Connect(function()
+			reject()
+		end))
+
 		maid:GiveTask(observable:Subscribe(resolve, reject, reject))
 	end)
 
@@ -1170,6 +1180,38 @@ function Rx.take(number)
 	end
 end
 
+--[=[
+	Takes n entries and then completes the observation.
+
+	https://rxjs.dev/api/operators/take
+	@param toSkip number
+	@return (source: Observable<T>) -> Observable<T>
+]=]
+function Rx.skip(toSkip)
+	assert(type(toSkip) == "number", "Bad toSkip")
+	assert(toSkip > 0, "Bad toSkip")
+
+	return function(source)
+		assert(Observable.isObservable(source), "Bad observable")
+
+		return Observable.new(function(sub)
+			local skipped = 0
+			local maid = Maid.new()
+
+			maid:GiveTask(source:Subscribe(function(...)
+				if skipped <= toSkip then
+					skipped = skipped + 1
+					return
+				end
+
+				sub:Fire(...)
+			end, sub:GetFailComplete()))
+
+			return maid
+		end)
+	end
+end
+
 --[=[
 	Defers the subscription and creation of the observable until the
 	actual subscription of the observable.

package/src/Shared/Subscription.lua

@@ -207,4 +207,11 @@ function Subscription:Destroy()
 	self:_doCleanup()
 end
 
+--[=[
+	Alias for [Subscription.Destroy].
+]=]
+function Subscription:Disconnect()
+	self:Destroy()
+end
+
 return Subscription