@session.js/types 1.0.0

package/README.md

@@ -0,0 +1,74 @@
+# @session.js/types
+
+A special package that holds TypeScript definitions and enums shared internally for developing your own @session.js/client modular parts.
+
+To build your own Storage adapter, use:
+
+```ts
+import type { Storage } from '@session.js/types'
+
+export class MyInMemoryStorage implements Storage {
+  storage: Map<string, string> = new Map()
+
+  get(key: string) {
+    return this.storage.get(key) ?? null
+  }
+
+  set(key: string, value: string) {
+    this.storage.set(key, value)
+  }
+
+  delete(key: string) {
+    this.storage.delete(key)
+  }
+
+  has(key: string) {
+    return this.storage.has(key)
+  }
+}
+```
+
+To build your own Network connecter, use:
+
+```ts
+import type { Network } from '@session.js/types'
+import { 
+  RequestType, 
+  type RequestGetSwarmsBody, 
+  type RequestPollBody, 
+  type RequestStoreBody, 
+  type RequestUploadAttachment 
+} from '@session.js/types/network/request'
+
+export class MyNetwork implements Network {
+  onRequest(type: RequestType, body: object): Promise<object> {
+    switch(type) {
+      case RequestType.Store:
+        return // typeof ResponseStore
+
+      case RequestType.GetSnodes:
+        return // typeof ResponseGetSnodes
+
+      case RequestType.GetSwarms:
+        return // typeof ResponseGetSwarms
+
+      case RequestType.Poll:
+        return // typeof ResponsePoll
+
+      case RequestType.UploadAttachment:
+        return // typeof ResponseUploadAttachment
+
+      default:
+        throw new Error('Invalid request type')
+    }
+  }
+}
+```
+
+## Made for session.js
+
+Use Session messenger programmatically with [Session.js](https://github.com/sessionjs/client): Session bots, custom Session clients, and more.
+
+## Donate
+
+[hloth.dev/donate](https://hloth.dev/donate)

package/dist/disappearing-message.d.ts

@@ -0,0 +1,2 @@
+export type DisappearingMessageType = (typeof DisappearingMessageMode)[number];
+export declare const DisappearingMessageMode: readonly ["unknown", "deleteAfterRead", "deleteAfterSend"];

package/dist/disappearing-message.js

@@ -0,0 +1 @@
+export const DisappearingMessageMode = ['unknown', 'deleteAfterRead', 'deleteAfterSend'];

package/dist/enums.d.ts

@@ -0,0 +1,3 @@
+export type PickEnum<T, K extends T> = {
+    [P in keyof K]: P extends K ? P : never;
+};

package/dist/enums.js

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

package/dist/envelope.d.ts

@@ -0,0 +1,6 @@
+import type { SignalService } from './signal-bindings/index.js';
+export interface EnvelopePlus extends Omit<SignalService.Envelope, 'toJSON'> {
+    senderIdentity: string;
+    receivedAt: number;
+    id: string;
+}

package/dist/envelope.js

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

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { SnodeNamespaces } from './namespaces.js';
+export type { Network } from './network/index.js';
+export type { Storage } from './storage/index.js';

package/dist/index.js

@@ -0,0 +1 @@
+export { SnodeNamespaces } from './namespaces.js';

package/dist/namespaces.d.ts

@@ -0,0 +1,42 @@
+import type { PickEnum } from './enums.js';
+export declare enum SnodeNamespaces {
+    /**
+     * This is the namespace anyone can deposit a message for us
+     */
+    UserMessages = 0,
+    /**
+     * This is the namespace used to sync our profile
+     */
+    UserProfile = 2,
+    /**
+     * This is the namespace used to sync our contacts
+     */
+    UserContacts = 3,
+    /**
+     * This is the namespace used to sync our volatile info (currently read status only)
+     */
+    ConvoInfoVolatile = 4,
+    /**
+     *  This is the namespace used to sync our user groups and communities
+     */
+    UserGroups = 5,
+    /** **THIS IS LEGACY AND SHOULD BE USED unless you know how to deal with legacy closed groups**. Use UserGroups instead.
+     * The messages sent to a closed group are sent and polled from this namespace
+     */
+    ClosedGroupMessage = -10
+}
+/**
+ * Returns true if that namespace is associated with the config of a user (not his messages, only configs)
+ */
+declare function isUserConfigNamespace(namespace: SnodeNamespaces): boolean;
+export type SnodeNamespacesGroup = PickEnum<SnodeNamespaces, SnodeNamespaces.ClosedGroupMessage>;
+export type SnodeNamespacesUser = PickEnum<SnodeNamespaces, SnodeNamespaces.UserContacts | SnodeNamespaces.UserProfile | SnodeNamespaces.UserMessages>;
+declare function maxSizeMap(namespaces: Array<SnodeNamespaces>): {
+    namespace: SnodeNamespaces;
+    maxSize: number;
+}[];
+export declare const SnodeNamespace: {
+    isUserConfigNamespace: typeof isUserConfigNamespace;
+    maxSizeMap: typeof maxSizeMap;
+};
+export {};

package/dist/namespaces.js

@@ -0,0 +1,99 @@
+// CREDIT: OXEN, Session-Desktop
+// github.com/oxen-io/session-desktop
+import _ from 'lodash';
+export var SnodeNamespaces;
+(function (SnodeNamespaces) {
+    /**
+     * This is the namespace anyone can deposit a message for us
+     */
+    SnodeNamespaces[SnodeNamespaces["UserMessages"] = 0] = "UserMessages";
+    /**
+     * This is the namespace used to sync our profile
+     */
+    SnodeNamespaces[SnodeNamespaces["UserProfile"] = 2] = "UserProfile";
+    /**
+     * This is the namespace used to sync our contacts
+     */
+    SnodeNamespaces[SnodeNamespaces["UserContacts"] = 3] = "UserContacts";
+    /**
+     * This is the namespace used to sync our volatile info (currently read status only)
+     */
+    SnodeNamespaces[SnodeNamespaces["ConvoInfoVolatile"] = 4] = "ConvoInfoVolatile";
+    /**
+     *  This is the namespace used to sync our user groups and communities
+     */
+    SnodeNamespaces[SnodeNamespaces["UserGroups"] = 5] = "UserGroups";
+    /** **THIS IS LEGACY AND SHOULD BE USED unless you know how to deal with legacy closed groups**. Use UserGroups instead.
+     * The messages sent to a closed group are sent and polled from this namespace
+     */
+    SnodeNamespaces[SnodeNamespaces["ClosedGroupMessage"] = -10] = "ClosedGroupMessage";
+    /**
+     * This is the namespace used to sync the closed group details for each of the closed groups we are polling
+     */
+    // ClosedGroupInfo = 1, // This is commented out in Session-desktop too
+})(SnodeNamespaces || (SnodeNamespaces = {}));
+/**
+ * Returns true if that namespace is associated with the config of a user (not his messages, only configs)
+ */
+function isUserConfigNamespace(namespace) {
+    switch (namespace) {
+        case SnodeNamespaces.UserMessages:
+            // user messages is not hosting config based messages
+            return false;
+        case SnodeNamespaces.UserContacts:
+        case SnodeNamespaces.UserProfile:
+        case SnodeNamespaces.UserGroups:
+        case SnodeNamespaces.ConvoInfoVolatile:
+            return true;
+        // This is commented out in Session-desktop too
+        // case SnodeNamespaces.ClosedGroupInfo:
+        case SnodeNamespaces.ClosedGroupMessage:
+            return false;
+        default:
+            throw new Error(`isUserConfigNamespace case not handled: ${namespace}`);
+    }
+}
+function namespacePriority(namespace) {
+    switch (namespace) {
+        case SnodeNamespaces.UserMessages:
+            return 10;
+        case SnodeNamespaces.UserContacts:
+            return 1;
+        case SnodeNamespaces.UserProfile:
+            return 1;
+        case SnodeNamespaces.UserGroups:
+            return 1;
+        case SnodeNamespaces.ConvoInfoVolatile:
+            return 1;
+        case SnodeNamespaces.ClosedGroupMessage:
+            return 10;
+        default:
+            throw new Error(`namespacePriority case not handled: ${namespace}`);
+    }
+}
+function maxSizeMap(namespaces) {
+    let lastSplit = 1;
+    const withPriorities = namespaces.map(namespace => {
+        return { namespace, priority: namespacePriority(namespace) };
+    });
+    const groupedByPriorities = [];
+    withPriorities.forEach(item => {
+        if (!groupedByPriorities.find(p => p.priority === item.priority)) {
+            groupedByPriorities.push({ priority: item.priority, namespaces: [] });
+        }
+        groupedByPriorities.find(p => p.priority === item.priority)?.namespaces.push(item.namespace);
+    });
+    const sortedDescPriorities = _.orderBy(groupedByPriorities, ['priority'], ['desc']);
+    const lowestPriority = _.last(sortedDescPriorities)?.priority || 1;
+    const sizeMap = sortedDescPriorities.flatMap(m => {
+        const paddingForLowerPriority = m.priority === lowestPriority ? 0 : 1;
+        const splitsForPriority = paddingForLowerPriority + m.namespaces.length;
+        lastSplit *= splitsForPriority;
+        return m.namespaces.map(namespace => ({ namespace, maxSize: -lastSplit }));
+    });
+    return sizeMap;
+}
+export const SnodeNamespace = {
+    isUserConfigNamespace,
+    maxSizeMap,
+};

package/dist/network/index.d.ts

@@ -0,0 +1,4 @@
+import type { RequestType } from './request.js';
+export interface Network {
+    onRequest(type: RequestType, body: unknown): Promise<unknown>;
+}

package/dist/network/index.js

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

package/dist/network/request.d.ts

@@ -0,0 +1,29 @@
+import type { Snode } from '../snode.js';
+import type { RequestNamespace } from '../snode-retrieve.js';
+import type { Swarm } from '../swarm.js';
+export declare enum RequestType {
+    Store = "/store",
+    GetSnodes = "/get_snodes",
+    GetSwarms = "/get_swarms",
+    Poll = "/poll",
+    UploadAttachment = "/upload_attachment"
+}
+export type RequestStoreBody = {
+    destination: string;
+    data64: string;
+    ttl: number;
+    timestamp: number;
+    namespace: number;
+    swarm: Swarm;
+};
+export type RequestGetSwarmsBody = {
+    snode: Snode;
+    pubkey: string;
+};
+export type RequestPollBody = {
+    swarm: Swarm;
+    namespaces: RequestNamespace[];
+};
+export type RequestUploadAttachment = {
+    data: ArrayBuffer;
+};

package/dist/network/request.js

@@ -0,0 +1,8 @@
+export var RequestType;
+(function (RequestType) {
+    RequestType["Store"] = "/store";
+    RequestType["GetSnodes"] = "/get_snodes";
+    RequestType["GetSwarms"] = "/get_swarms";
+    RequestType["Poll"] = "/poll";
+    RequestType["UploadAttachment"] = "/upload_attachment";
+})(RequestType || (RequestType = {}));

package/dist/network/response.d.ts

@@ -0,0 +1,23 @@
+import type { SnodeNamespaces } from '../namespaces.js';
+import type { Snode } from '../snode.js';
+import type { RetrieveMessageItem } from '../snode-retrieve.js';
+import type { Swarm } from '../swarm.js';
+export type ResponseStore = {
+    hash: string;
+};
+export type ResponseGetSnodes = {
+    snodes: Snode[];
+};
+export type ResponseGetSwarms = {
+    swarms: Swarm[];
+};
+export type ResponsePoll = {
+    messages: {
+        namespace: SnodeNamespaces;
+        messages: RetrieveMessageItem[];
+    }[];
+};
+export type ResponseUploadAttachment = {
+    url: string;
+    id: number;
+};

package/dist/network/response.js

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

package/dist/pubkey.d.ts

@@ -0,0 +1,22 @@
+export declare enum KeyPrefixType {
+    /**
+     * Used for keys which have the blinding update and aren't using blinding
+     */
+    unblinded = "00",
+    /**
+     * Used for identified users, open groups, etc
+     */
+    standard = "05",
+    /**
+     * used for participants in open groups (legacy blinding logic)
+     */
+    blinded15 = "15",
+    /**
+     * used for participants in open groups (new blinding logic)
+     */
+    blinded25 = "25",
+    /**
+     * used for participants in open groups
+     */
+    groupV3 = "03"
+}

package/dist/pubkey.js

@@ -0,0 +1,23 @@
+export var KeyPrefixType;
+(function (KeyPrefixType) {
+    /**
+     * Used for keys which have the blinding update and aren't using blinding
+     */
+    KeyPrefixType["unblinded"] = "00";
+    /**
+     * Used for identified users, open groups, etc
+     */
+    KeyPrefixType["standard"] = "05";
+    /**
+     * used for participants in open groups (legacy blinding logic)
+     */
+    KeyPrefixType["blinded15"] = "15";
+    /**
+     * used for participants in open groups (new blinding logic)
+     */
+    KeyPrefixType["blinded25"] = "25";
+    /**
+     * used for participants in open groups
+     */
+    KeyPrefixType["groupV3"] = "03";
+})(KeyPrefixType || (KeyPrefixType = {}));