@socketsupply/socket-api

v0.2.17

Published

6 months ago

Socket Runtime JavaScript interface

Downloads

0High
0Medium
0Low

chicoxyzzy

hij1nx

werle

Bluetooth

A high level, cross-platform API for Bluetooth Pub-Sub

`Bluetooth` (extends `EventEmitter`)

Create an instance of a Bluetooth service.

`constructor(serviceId)`

constructor is an example property that is set to true Creates a new service with key-value pairs

`start()`

Start the bluetooth service.

Start scanning for published values that correspond to a well-known UUID. Once subscribed to a UUID, events that correspond to that UUID will be emitted. To receive these events you can add an event listener, for example...

const ble = new Bluetooth(id)
ble.subscribe(uuid)
ble.on(uuid, (data, details) => {
  // ...do something interesting
})

| Argument | Type | Default | Optional | Description | | :--- | :--- | :---: | :---: | :--- | | id | string | | false | A well-known UUID |

`publish(id, value)`

Start advertising a new value for a well-known UUID

Buffer

External docs: https://nodejs.org/api/buffer.html#buffer_class_buffer

The buffer module from node.js, for the browser.

Buffer

If Buffer.TYPED_ARRAY_SUPPORT: === true Use Uint8Array implementation (fastest) === false Print warning and recommend using buffer v4.x which has an Object implementation (most compatible, even IE6)

Browsers that support typed arrays are IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

We report that the browser does not support typed arrays if the are not subclassable using proto. Firefox 4-29 lacks support for adding new properties to Uint8Array (See: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 lacks support for proto and has a buggy typed array implementation.

undefined

Browsers that support typed arrays are IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

undefined

Browsers that support typed arrays are IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

undefined

Browsers that support typed arrays are IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

undefined

The Buffer constructor returns instances of Uint8Array that have their prototype changed to Buffer.prototype. Furthermore, Buffer is a subclass of Uint8Array, so the returned instances will have all the node Buffer methods and the Uint8Array methods. Square bracket notation works as expected -- it returns a single octet.

The Uint8Array prototype remains unmodified.

Buffer

Functionally equivalent to Buffer(arg, encoding) but throws a TypeError if value is a number. Buffer.from(str[, encoding]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])

undefined

Buffer

Creates a new filled Buffer instance. alloc(size[, fill[, encoding]])

undefined

Creates a new filled Buffer instance. alloc(size[, fill[, encoding]])

undefined

Creates a new filled Buffer instance. alloc(size[, fill[, encoding]])

undefined

Creates a new filled Buffer instance. alloc(size[, fill[, encoding]])

Buffer

Equivalent to Buffer(num), by default creates a non-zero-filled Buffer instance.

undefined

Equivalent to Buffer(num), by default creates a non-zero-filled Buffer instance.

undefined

Equivalent to Buffer(num), by default creates a non-zero-filled Buffer instance.

undefined

Equivalent to Buffer(num), by default creates a non-zero-filled Buffer instance.

Buffer

Equivalent to SlowBuffer(num), by default creates a non-zero-filled Buffer instance.

undefined

Equivalent to SlowBuffer(num), by default creates a non-zero-filled Buffer instance.

undefined

Equivalent to SlowBuffer(num), by default creates a non-zero-filled Buffer instance.

undefined

Equivalent to SlowBuffer(num), by default creates a non-zero-filled Buffer instance.

Crypto

Some high level methods around the crypto.subtle api for getting random bytes and hashing.

webcrypto

WebCrypto API

`getRandomValues(buffer)`

External docs: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues

Generate cryptographically strong random values into buffer

RANDOM_BYTES_QUOTA

Maximum total size of random bytes per page

MAX_RANDOM_BYTES

Maximum total size for random bytes.

MAX_RANDOM_BYTES_PAGES

Maximum total amount of allocated per page of bytes (max/quota)

`randomBytes(size)`

Generate size random bytes.

`createDigest(algorithm, message)`

Dgram

This module provides an implementation of UDP datagram sockets. It does not (yet) provide any of the multicast methods or properties.

`ERR_SOCKET_ALREADY_BOUND` (extends `SocketError`)

Thrown when a socket is already bound.

`ERR_SOCKET_DGRAM_IS_CONNECTED` (extends `SocketError`)

Thrown when the socket is already connected.

`ERR_SOCKET_DGRAM_NOT_CONNECTED` (extends `SocketError`)

Thrown when the socket is not connected.

`ERR_SOCKET_DGRAM_NOT_RUNNING` (extends `SocketError`)

Thrown when the socket is not running (not bound or connected).

`ERR_SOCKET_BAD_TYPE` (extends `TypeError`)

Thrown when a bad socket type is used in an argument.

`ERR_SOCKET_BAD_PORT` (extends `RangeError`)

Thrown when a bad port is given.

`createSocket(options, callback)`

Creates a Socket instance. if ()

`Socket` (extends `EventEmitter`)

New instances of dgram.Socket are created using dgram.createSocket(). The new keyword is not to be used to create dgram.Socket instances.

`bind(port, address, callback)`

External docs: https://nodejs.org/api/dgram.html#socketbindport-address-callback

Listen for datagram messages on a named port and optional address If address is not specified, the operating system will attempt to listen on all addresses. Once binding is complete, a 'listening' event is emitted and the optional callback function is called.

If binding fails, an 'error' event is emitted.

`connect(port, host, connectListener)`

External docs: https://nodejs.org/api/dgram.html#socketconnectport-address-callback

Associates the dgram.Socket to a remote address and port. Every message sent by this handle is automatically sent to that destination. Also, the socket will only receive messages from that remote peer. Trying to call connect() on an already connected socket will result in an ERR_SOCKET_DGRAM_IS_CONNECTED exception. If address is not provided, '127.0.0.1' (for udp4 sockets) or '::1' (for udp6 sockets) will be used by default. Once the connection is complete, a 'connect' event is emitted and the optional callback function is called. In case of failure, the callback is called or, failing this, an 'error' event is emitted.

`disconnect()`

External docs: https://nodejs.org/api/dgram.html#socketdisconnect

A synchronous function that disassociates a connected dgram.Socket from its remote address. Trying to call disconnect() on an unbound or already disconnected socket will result in an ERR_SOCKET_DGRAM_NOT_CONNECTED exception.

`send(msg, offset, length, port, address, callback)`

External docs: https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback

Broadcasts a datagram on the socket. For connectionless sockets, the destination port and address must be specified. Connected sockets, on the other hand, will use their associated remote endpoint, so the port and address arguments must not be set.

The msg argument contains the message to be sent. Depending on its type, different behavior can apply. If msg is a Buffer, any TypedArray or a DataView, the offset and length specify the offset within the Buffer where the message begins and the number of bytes in the message, respectively. If msg is a String, then it is automatically converted to a Buffer with 'utf8' encoding. With messages that contain multi-byte characters, offset and length will be calculated with respect to byte length and not the character position. If msg is an array, offset and length must not be specified.

The address argument is a string. If the value of address is a host name, DNS will be used to resolve the address of the host. If address is not provided or otherwise nullish, '127.0.0.1' (for udp4 sockets) or '::1' (for udp6 sockets) will be used by default.

If the socket has not been previously bound with a call to bind, the socket is assigned a random port number and is bound to the "all interfaces" address ('0.0.0.0' for udp4 sockets, '::0' for udp6 sockets.)

An optional callback function may be specified to as a way of reporting DNS errors or for determining when it is safe to reuse the buf object. DNS lookups delay the time to send for at least one tick of the Node.js event loop.

The only way to know for sure that the datagram has been sent is by using a callback. If an error occurs and a callback is given, the error will be passed as the first argument to the callback. If a callback is not given, the error is emitted as an 'error' event on the socket object.

Offset and length are optional but both must be set if either are used. They are supported only when the first argument is a Buffer, a TypedArray, or a DataView.

`close(callback)`

External docs: https://nodejs.org/api/dgram.html#socketclosecallback

Close the underlying socket and stop listening for data on it. If a callback is provided, it is added as a listener for the 'close' event.

`address()`

External docs: https://nodejs.org/api/dgram.html#socketaddress

Returns an object containing the address information for a socket. For UDP sockets, this object will contain address, family, and port properties.

This method throws EBADF if called on an unbound socket.

`remoteAddress()`

External docs: https://nodejs.org/api/dgram.html#socketremoteaddress

Returns an object containing the address, family, and port of the remote endpoint. This method throws an ERR_SOCKET_DGRAM_NOT_CONNECTED exception if the socket is not connected.

`setRecvBufferSize(size)`

External docs: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize

Sets the SO_RCVBUF socket option. Sets the maximum socket receive buffer in bytes.

`setSendBufferSize(size)`

External docs: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize

Sets the SO_SNDBUF socket option. Sets the maximum socket send buffer in bytes.

`getRecvBufferSize()`

External docs: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize

`getSendBufferSize()`

External docs: https://nodejs.org/api/dgram.html#socketgetsendbuffersize

DNS

This module enables name resolution. For example, use it to look up IP addresses of host names. Although named for the Domain Name System (DNS), it does not always use the DNS protocol for lookups. dns.lookup() uses the operating system facilities to perform name resolution. It may not need to perform any network communication. To perform name resolution the way other applications on the same system do, use dns.lookup().

`lookup(hostname, opts, cb)`

External docs: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback

Resolves a host name (e.g. example.org) into the first found A (IPv4) or AAAA (IPv6) record. All option properties are optional. If options is an integer, then it must be 4 or 6 – if options is 0 or not provided, then IPv4 and IPv6 addresses are both returned if found.

From the node.js website...

With the all option set to true, the arguments for callback change to (err, addresses), with addresses being an array of objects with the properties address and family.

On error, err is an Error object, where err.code is the error code. Keep in mind that err.code will be set to 'ENOTFOUND' not only when the host name does not exist but also when the lookup fails in other ways such as no available file descriptors. dns.lookup() does not necessarily have anything to do with the DNS protocol. The implementation uses an operating system facility that can associate names with addresses and vice versa. This implementation can have subtle but important consequences on the behavior of any Node.js program. Please take some time to consult the Implementation considerations section before using dns.lookup().

DNS.promises

`lookup(hostname, opts)`

External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options

File System

This module enables interacting with the file system in a way modeled on standard POSIX functions.

The Application Sandbox restricts access to the file system. Please see the Application Sandbox documentation for more information: https://sockets.sh/guides/#working-with-the-file-system-on-ios

To use the promise-based APIs:

import * as fs from '@socketsupply/socket-api/fs/promises.js';

To use the callback and async APIs:

import * as fs from '@socketsupply/socket-api/fs/index.js';

`access(path, mode , callback)`

External docs: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsopenpath-flags-mode-callback

Asynchronously check access a file for a given mode calling callback upon success or error.

`chmod(path, mode, callback)`

External docs: https://nodejs.org/api/fs.html#fschmodpath-mode-callback

Asynchronously changes the permissions of a file. No arguments other than a possible exception are given to the completion callback

`close(fd, callback)`

Asynchronously close a file descriptor calling callback upon success or error.

`copyFile()`

This is a FunctionDeclaration named copyFile in fs/index.js, it's exported but undocumented.

`createReadStream(path, options)`

External docs: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options

`createWriteStream(path, options)`

External docs: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options

`fstat(fd, options, callback)`

External docs: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsfstatfd-options-callback

Invokes the callback with the <fs.Stats> for the file descriptor. See the POSIX fstat(2) documentation for more detail.

`open(path, flags , mode , callback)`

Asynchronously open a file calling callback upon success or error.

`opendir(path, options, callback)`

Asynchronously open a directory calling callback upon success or error.

`read(fd, buffer, offset, length, position, callback)`

Asynchronously read from an open file descriptor.

`readdir(path, options, callback)`

Asynchronously read all entries in a directory.

`readFile(path, options, callback)`

`stat(path, options, callback)`

`writeFile(path, data, options, callback)`

`writev()`

This is a FunctionDeclaration named writev in fs/index.js, it's exported but undocumented.

FS.promises

`access(path, mode, options)`

External docs: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesaccesspath-mode

Asynchronously check access a file.

`chmod(path, mode)`

External docs: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode

`mkdir(path, options)`

Asynchronously creates a directory.

`open(path, flags, mode)`

External docs: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode

Asynchronously open a file.

`opendir(path, options)`

External docs: https://nodejs.org/api/fs.html#fspromisesopendirpath-options

`readdir(path, options)`

External docs: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options

`readFile(path, options)`

External docs: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options

`stat(path, options)`

External docs: https://nodejs.org/api/fs.html#fspromisesstatpath-options

`writeFile(path, data, options)`

External docs: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options

FS.Stream

DEFAULT_STREAM_HIGH_WATER_MARK

This is a VariableDeclaration named DEFAULT_STREAM_HIGH_WATER_MARK in fs/stream.js, it's exported but undocumented.

`ReadStream` (extends `Readable`)

A Readable stream for a FileHandle.

`constructor()`

ReadStream class constructor

`setHandle(handle)`

Sets file handle for the ReadStream.

`highWaterMark()`

The max buffer size for the ReadStream.

`path()`

Relative or absolute path of the underlying FileHandle.

`pending()`

true if the stream is in a pending state.

`emit()`

Handles shouldEmitClose setting from options.emitClose in constructor.

`WriteStream` (extends `Writable`)

A Writable stream for a FileHandle.

`constructor()`

WriteStream class constructor

`setHandle(handle)`

Sets file handle for the WriteStream.

`highWaterMark()`

The max buffer size for the Writetream.

`path()`

Relative or absolute path of the underlying FileHandle.

`pending()`

true if the stream is in a pending state.

`emit()`

Handles shouldEmitClose setting from options.emitClose in constructor.

FileReadStream

This is a VariableDeclaration named FileReadStream in fs/stream.js, it's exported but undocumented.

FileWriteStream

This is a VariableDeclaration named FileWriteStream in fs/stream.js, it's exported but undocumented.

IPC

This is a low level API which you don't need unless you are implementing a library on top of Socket SDK. A Socket SDK app has two or three processes.

The Render process, the UI where the HTML, CSS and JS is run.
The Bridge process, the thin layer of code that managers everything.
The Main processs, for apps that need to run heavier compute jobs. And unlike electron it's optional.

The Bridge process manages the Render and Main process, it may also broker data between them.

The Binding process uses standard input and output as a way to communicate. Data written to the write-end of the pipe is buffered by the OS until it is read from the read-end of the pipe.

The IPC protocol uses a simple URI-like scheme. Data is passed as ArrayBuffers.

ipc://command?key1=value1&key2=value2...

`postMessage()`

This is a FunctionDeclaration named postMessage in ipc.js, it's exported but undocumented.

OK

Represents an OK IPC status.

ERROR

Represents an ERROR IPC status.

TIMEOUT

Timeout in milliseconds for IPC requests.

kDebugEnabled

Symbol for the ipc.debug.enabled property

`parseSeq(seq, options)`

Parses seq as integer value

`debug(enable)`

If debug.enabled === true, then debug output will be printed to console.

`Message` (extends `URL`)

A container for a IPC message based on a ipc:// URI scheme.

`PROTOCOL()`

The expected protocol for an IPC message.

`from(input, params)`

Creates a Message instance from a variety of input.

`isValidInput(input)`

Predicate to determine if input is valid for constructing a new Message instance.

`constructor(input)`

Message class constructor.

| Argument | Type | Default | Optional | Description | | :--- | :--- | :---: | :---: | :--- | | input | string | URL | | false | |

`command()`

Computed IPC message name.

`name()`

Computed IPC message name.

`id()`

Computed id value for the command.

`seq()`

Computed seq (sequence) value for the command.

`value()`

Computed message value potentially given in message parameters. This value is automatically decoded, but not treated as JSON.

`index()`

Computed index value for the command potentially referring to the window index the command is scoped to or originating from. If not specified in the message parameters, then this value defaults to -1.

`json()`

Computed value parsed as JSON. This value is null if the value is not present or it is invalid JSON.

`params()`

Computed readonly object of message parameters.

`entries()`

Returns computed parameters as entries

`set(key, value)`

Set a parameter value by key.

`get(key, defaultValue)`

Get a parameter value by key.

`delete(key)`

Delete a parameter by key.

| Argument | Type | Default | Optional | Description | | :--- | :--- | :---: | :---: | :--- | | key | string | | false | |

`keys()`

Computed parameter keys.

`values()`

Computed parameter values.

`has(key)`

Predicate to determine if parameter key is present in parameters.

| Argument | Type | Default | Optional | Description | | :--- | :--- | :---: | :---: | :--- | | key | string | | false | |

`toJSON()`

Converts a Message instance into a plain JSON object.

Result

A result type used internally for handling IPC result values from the native layer that are in the form of { err?, data? }. The data and err properties on this type of object are in tuple form and be accessed at [data?,err?]

`from(result, maybeError, maybeSource)`

Creates a Result instance from input that may be an object like { err?, data? }, an Error instance, or just data.

`constructor(err , data , source )`

Result class constructor.

`length()`

Computed result length.

`ready()`

Waits for the native IPC layer to be ready and exposed on the global window object.

`sendSync(command, params)`

Sends a synchronous IPC command over XHR returning a Result upon success or error.

`emit(name, value, target , options)`

Emit event to be dispatched on window object.

`resolve(seq, value)`

Resolves a request by seq with possible value.

`send(command, value)`

Sends an async IPC command request with parameters.

`write(command, params, buffer, options)`

Sends an async IPC command request with parameters and buffered bytes.

`request(command, params, options)`

Sends an async IPC command request with parameters requesting a response with buffered bytes.

`createBinding(domain, ctx)`

Factory for creating a proxy based IPC API.

OS

This module provides normalized system information from all the major operating systems.

`arch()`

This is a FunctionDeclaration named arch in os.js, it's exported but undocumented.

`networkInterfaces()`

This is a FunctionDeclaration named networkInterfaces in os.js, it's exported but undocumented.

`platform()`

This is a FunctionDeclaration named platform in os.js, it's exported but undocumented.

`type()`

This is a FunctionDeclaration named type in os.js, it's exported but undocumented.

`isWindows()`

This is a FunctionDeclaration named isWindows in os.js, it's exported but undocumented.

`tmpdir()`

This is a FunctionDeclaration named tmpdir in os.js, it's exported but undocumented.

EOL

This is a VariableDeclaration named EOL in os.js, it's exported but undocumented.

Path

This is a ClassDeclaration named Path in path/path.js, it's exported but undocumented.

`cwd(opts)`

Computes current working directory for a path

`constructor(opts)`

Path class constructor.

`resolve()`

`normalize()`

Process

`homedir()`

`exit(code)`

Runtime

Provides runtime-specific methods

currentWindow

This is a VariableDeclaration named currentWindow in runtime.js, it's exported but undocumented.

debug

This is a VariableDeclaration named debug in runtime.js, it's exported but undocumented.

config

This is a VariableDeclaration named config in runtime.js, it's exported but undocumented.

`send()`

This is a FunctionDeclaration named send in runtime.js, it's exported but undocumented.

`getWindows()`

This is a FunctionDeclaration named getWindows in runtime.js, it's exported but undocumented.

`openExternal()`

This is a FunctionDeclaration named openExternal in runtime.js, it's exported but undocumented.

`exit(options)`

Quits the backend process and then quits the render process, the exit code used is the final exit code to the OS.

`setTitle(options)`

Sets the title of the window (if applicable).

`inspect()`

This is a FunctionDeclaration named inspect in runtime.js, it's exported but undocumented.

`show(opts)`

`hide(opts)`

`navigate(opts)`

`setWindowBackgroundColor()`

This is a FunctionDeclaration named setWindowBackgroundColor in runtime.js, it's exported but undocumented.

`setContextMenu(options)`

Opens a native context menu.

`setSystemMenuItemEnabled()`

This is a FunctionDeclaration named setSystemMenuItemEnabled in runtime.js, it's exported but undocumented.

`setSystemMenu(options)`

Set the native menu for the app.

Socket Runtime provides a minimalist DSL that makes it easy to create cross platform native system and context menus.

Menus are created at run time. They can be created from either the Main or Render process. The can be recreated instantly by calling the setSystemMenu method.

The method takes a string. Here's an example of a menu. The semi colon is significant indicates the end of the menu. Use an underscore when there is no accelerator key. Modifiers are optional. And well known OS menu options like the edit menu will automatically get accelerators you dont need to specify them.

socket.runtime.setSystemMenu({ index: 0, value: `
  App:
    Foo: f;

  Edit:
    Cut: x
    Copy: c
    Paste: v
    Delete: _
    Select All: a;

  Other:
    Apple: _
    Another Test: T
    !Im Disabled: I
    Some Thing: S + Meta
    ---
    Bazz: s + Meta, Control, Alt;
`)

Separators

To create a separator, use three dashes ---.

Accelerator Modifiers

Accelerator modifiers are used as visual indicators but don't have a material impact as the actual key binding is done in the event listener.

A capital letter implies that the accelerator is modified by the Shift key.

Additional accelerators are Meta, Control, Option, each separated by commas. If one is not applicable for a platform, it will just be ignored.

On MacOS Meta is the same as Command.

Disabled Items

If you want to disable a menu item just prefix the item with the ! character. This will cause the item to appear disabled when the system menu renders.

Submenus

We feel like nested menus are an anti-pattern. We don't use them. If you have a strong argument for them and a very simple pull request that makes them work we may consider them.

Event Handling

When a menu item is activated, it raises the menuItemSelected event in the front end code, you can then communicate with your backend code if you want from there.

For example, if the Apple item is selected from the Other menu...

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme