@crewdle/web-sdk-types 1.0.0

package/dist/pubsub/SubscribeFunction.d.ts

@@ -0,0 +1,14 @@
+import { ISubscriptions, SubscriptionKeys } from '.';
+/**
+ * The pub/sub topic subscribe function.
+ * @category Pub/Sub
+ */
+export type SubscribeFunction<T> = {
+    /**
+     * Subscribe to the topic.
+     * @typeParam U - Any of the content types defined in {@link ISubscriptions}.
+     * @param contentType - One of the content type defined in {@link ISubscriptions}.
+     * @param callback - The callback when the content is received. callbacks' payload are defined in {@link ISubscriptions}.
+     */
+    <U extends SubscriptionKeys<T>>(contentType: U, callback: ISubscriptions<T>[U]): void;
+};

package/dist/pubsub/SubscribeFunction.js

@@ -0,0 +1 @@
+export {};

package/dist/pubsub/SubscriptionKeys.d.ts

@@ -0,0 +1,6 @@
+import { ISubscriptions } from '.';
+/**
+ * The pub/sub topic subscription keys.
+ * @category Pub/Sub
+ */
+export type SubscriptionKeys<T> = keyof ISubscriptions<T>;

package/dist/pubsub/SubscriptionKeys.js

@@ -0,0 +1 @@
+export {};

package/dist/pubsub/Subscriptions.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The pub/sub topic subscriptions interface.
+ * @category Pub/Sub
+ */
+export interface ISubscriptions<T> {
+    /**
+     * @event data - To subscribe to data events.
+     * @param nodeId The node ID of the node who published the data.
+     * @param content The content that was published.
+     */
+    'data': (nodeId: string, content: T) => void;
+    /**
+     * @event file - To subscribe to file events.
+     * @param nodeId The node ID of the node who published the file.
+     * @param content The file that was published.
+     */
+    'file': (nodeId: string, content: File) => void;
+}

package/dist/pubsub/Subscriptions.js

@@ -0,0 +1 @@
+export {};

package/dist/pubsub/index.d.ts

@@ -0,0 +1,4 @@
+export { IPubSubTopic } from './PubSubTopic';
+export { SubscribeFunction } from './SubscribeFunction';
+export { SubscriptionKeys } from './SubscriptionKeys';
+export { ISubscriptions } from './Subscriptions';

package/dist/pubsub/index.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@crewdle/web-sdk-types",
+  "version": "1.0.0",
+  "description": "The Crewdle Mist Web SDK public types and interfaces",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rm -rf dist && tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Crewdle/web-sdk-types.git"
+  },
+  "author": "Crewdle Technologies",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Crewdle/web-sdk-types/issues"
+  },
+  "homepage": "https://github.com/Crewdle/web-sdk-types#readme",
+  "devDependencies": {
+    "typescript": "^5.4.3"
+  },
+  "files": [
+    "dist/"
+  ]
+}