@supabase/phoenix 0.1.0

package/priv/static/types/types.d.ts

@@ -0,0 +1,280 @@
+/**
+ * MISC
+ */
+export type Params = Record<string, unknown>;
+export type Closure<T> = T | (() => T);
+/**
+ * CHANNEL
+ */
+export type ChannelBindingCallback = (payload: unknown, ref: string | null | undefined, joinRef: string) => void;
+/**
+ * CHANNEL
+ */
+export type ChannelOnErrorCallback = (reason: unknown) => void;
+/**
+ * CHANNEL
+ */
+export type ChannelBinding = ({
+    event: string;
+    ref: number;
+    callback: ChannelBindingCallback;
+});
+/**
+ * CHANNEL
+ */
+export type ChannelOnMessage = (event: string, payload?: unknown, ref?: string | null, joinRef?: string | null) => unknown;
+/**
+ * CHANNEL
+ */
+export type ChannelFilterBindings = (binding: ChannelBinding, payload: unknown, ref?: string | null) => boolean;
+/**
+ * CONSTANTS
+ */
+export type Vsn = "1.0.0" | "2.0.0";
+/**
+ * CONSTANTS
+ */
+export type SocketState = (typeof SOCKET_STATES)[keyof typeof SOCKET_STATES];
+/**
+ * CONSTANTS
+ */
+export type ChannelState = (typeof CHANNEL_STATES)[keyof typeof CHANNEL_STATES];
+/**
+ * CONSTANTS
+ */
+export type ChannelEvent = (typeof CHANNEL_EVENTS)[keyof typeof CHANNEL_EVENTS];
+/**
+ * CONSTANTS
+ */
+export type Transport = (typeof TRANSPORTS)[keyof typeof TRANSPORTS];
+/**
+ * CONSTANTS
+ */
+export type XhrState = (typeof XHR_STATES)[keyof typeof XHR_STATES];
+/**
+ * PRESENCE
+ */
+export type PresenceEvents = {
+    state: string;
+    diff: string;
+};
+/**
+ * PRESENCE
+ */
+export type PresenceOnJoin = (key: string, currentPresence: PresenceState, newPresence: PresenceState) => void;
+/**
+ * PRESENCE
+ */
+export type PresenceOnLeave = (key: string, currentPresence: PresenceState, leftPresence: PresenceState) => void;
+/**
+ * PRESENCE
+ */
+export type PresenceOnSync = () => void;
+/**
+ * PRESENCE
+ */
+export type PresenceDiff = ({
+    joins: PresenceState;
+    leaves: PresenceState;
+});
+/**
+ * PRESENCE
+ */
+export type PresenceState = ({
+    metas: {
+        phx_ref?: string;
+        phx_ref_prev?: string;
+        [key: string]: any;
+    }[];
+});
+/**
+ * PRESENCE
+ */
+export type PresenceOptions = {
+    events?: PresenceEvents | undefined;
+};
+/**
+ * SERIALIZER
+ */
+export type Message<T> = ({
+    join_ref?: string | null;
+    ref?: string | null;
+    event: string;
+    topic: string;
+    payload: T;
+});
+export type Encode<T> = (msg: Message<Record<string, any>>, callback: (result: ArrayBuffer | string) => T) => T;
+export type Decode<T> = (rawPayload: ArrayBuffer | string, callback: (msg: Message<unknown>) => T) => T;
+/**
+ * SOCKET
+ */
+export type SocketTransport = (typeof WebSocket | typeof LongPoll);
+/**
+ * SOCKET
+ */
+export type SocketOnOpen = () => void;
+/**
+ * SOCKET
+ */
+export type SocketOnClose = (event: CloseEvent) => void;
+/**
+ * SOCKET
+ */
+export type SocketOnError = (error: Event, transportBefore: SocketTransport, establishedBefore: number) => void;
+/**
+ * SOCKET
+ */
+export type SocketOnMessage = (rawMessage: Message<unknown>) => void;
+/**
+ * SOCKET
+ */
+export type SocketStateChangeCallbacks = ({
+    open: [string, SocketOnOpen][];
+    close: [string, SocketOnClose][];
+    error: [string, SocketOnError][];
+    message: [string, SocketOnMessage][];
+});
+/**
+ * SOCKET
+ */
+export type HeartbeatStatus = "sent" | "ok" | "error" | "timeout" | "disconnected";
+/**
+ * SOCKET
+ */
+export type HeartbeatCallback = (status: HeartbeatStatus, latency?: number) => void;
+/**
+ * SOCKET
+ */
+export type SocketOptions = {
+    /**
+     * - The Websocket Transport, for example WebSocket or Phoenix.LongPoll.
+     */
+    transport?: SocketTransport | undefined;
+    /**
+     * - The millisecond time to attempt the primary transport
+     * before falling back to the LongPoll transport. Disabled by default.
+     */
+    longPollFallbackMs?: number | undefined;
+    /**
+     * - The millisecond time before LongPoll transport times out. Default 20000.
+     */
+    longpollerTimeout?: number | undefined;
+    /**
+     * - When true, enables debug logging. Default false.
+     */
+    debug?: boolean | undefined;
+    /**
+     * - The function to encode outgoing messages.
+     * Defaults to JSON encoder.
+     */
+    encode?: Encode<void> | undefined;
+    /**
+     * - The function to decode incoming messages.
+     * Defaults to JSON:
+     *
+     * ```javascript
+     * (payload, callback) => callback(JSON.parse(payload))
+     * ```
+     */
+    decode?: Decode<void> | undefined;
+    /**
+     * - The default timeout in milliseconds to trigger push timeouts.
+     * Defaults `DEFAULT_TIMEOUT`
+     */
+    timeout?: number | undefined;
+    /**
+     * - The millisec interval to send a heartbeat message
+     */
+    heartbeatIntervalMs?: number | undefined;
+    /**
+     * - Whether to automatically send heartbeats after
+     * connection is established.
+     *
+     * Defaults to true.
+     */
+    autoSendHeartbeat?: boolean | undefined;
+    /**
+     * - The optional function to handle heartbeat status and latency.
+     */
+    heartbeatCallback?: HeartbeatCallback | undefined;
+    /**
+     * - The optional function that returns the
+     * socket reconnect interval, in milliseconds.
+     *
+     * Defaults to stepped backoff of:
+     *
+     * ```javascript
+     * function(tries){
+     * return [10, 50, 100, 150, 200, 250, 500, 1000, 2000][tries - 1] || 5000
+     * }
+     * ````
+     */
+    reconnectAfterMs?: ((tries: number) => number) | undefined;
+    /**
+     * - The optional function that returns the millisec
+     * rejoin interval for individual channels.
+     *
+     * ```javascript
+     * function(tries){
+     * return [1000, 2000, 5000][tries - 1] || 10000
+     * }
+     * ````
+     */
+    rejoinAfterMs?: ((tries: number) => number) | undefined;
+    /**
+     * - The optional function for specialized logging, ie:
+     *
+     * ```javascript
+     * function(kind, msg, data) {
+     * console.log(`${kind}: ${msg}`, data)
+     * }
+     * ```
+     */
+    logger?: ((kind: string, msg: string, data: any) => void) | undefined;
+    /**
+     * - The optional params to pass when connecting
+     */
+    params?: Closure<Params> | undefined;
+    /**
+     * - the optional authentication token to be exposed on the server
+     * under the `:auth_token` connect_info key.
+     */
+    authToken?: string | undefined;
+    /**
+     * - The binary type to use for binary WebSocket frames.
+     *
+     * Defaults to "arraybuffer"
+     */
+    binaryType?: BinaryType | undefined;
+    /**
+     * - The serializer's protocol version to send on connect.
+     *
+     * Defaults to DEFAULT_VSN.
+     */
+    vsn?: Vsn | undefined;
+    /**
+     * - An optional Storage compatible object
+     * Phoenix uses sessionStorage for longpoll fallback history. Overriding the store is
+     * useful when Phoenix won't have access to `sessionStorage`. For example, This could
+     * happen if a site loads a cross-domain channel in an iframe. Example usage:
+     *
+     * class InMemoryStorage {
+     * constructor() { this.storage = {} }
+     * getItem(keyName) { return this.storage[keyName] || null }
+     * removeItem(keyName) { delete this.storage[keyName] }
+     * setItem(keyName, keyValue) { this.storage[keyName] = keyValue }
+     * }
+     */
+    sessionStorage?: Storage | undefined;
+    /**
+     * - Callback ran before socket tries to reconnect.
+     */
+    beforeReconnect?: (() => Promise<void>) | undefined;
+};
+import type { SOCKET_STATES } from "./constants";
+import type { CHANNEL_STATES } from "./constants";
+import type { CHANNEL_EVENTS } from "./constants";
+import type { TRANSPORTS } from "./constants";
+import type { XHR_STATES } from "./constants";
+import type LongPoll from "./longpoll";
+//# sourceMappingURL=types.d.ts.map

package/priv/static/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../assets/js/phoenix/types.js"],"names":[],"mappings":";;;qBAMa,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;oBAIvB,CAAC,IACD,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;;;;qCAMb,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI;;;;qCAC3E,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI;;;;6BACzB,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,sBAAsB,CAAA;CAAC,CAAC;;;;+BAChE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAG,MAAM,OAAA,EAAE,OAAO,CAAC,EAAG,MAAM,OAAA,KAAK,OAAO;;;;oCAC/E,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,EAAG,MAAM,OAAA,KAAK,OAAO;;;;kBAOrE,OAAO,GAAG,OAAO;;;;0BACjB,CAAO,oBAAa,EAAC,MAAa,oBAAa,CAAC;;;;2BAChD,CAAO,qBAAc,EAAC,MAAa,qBAAc,CAAC;;;;2BAClD,CAAO,qBAAc,EAAC,MAAa,qBAAc,CAAC;;;;wBAClD,CAAO,iBAAU,EAAC,MAAa,iBAAU,CAAC;;;;uBAC1C,CAAO,iBAAU,EAAC,MAAa,iBAAU,CAAC;;;;6BAK1C;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC;;;;6BAC7B,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,KAAK,IAAI;;;;8BACjF,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,KAAK,IAAI;;;;6BAClF,MAAM,IAAI;;;;2BACV,CAAC;IAAC,KAAK,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,aAAa,CAAA;CAAC,CAAC;;;;4BAC/C,CACZ;IACK,KAAK,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,YAAY,CAAC,EAAE,MAAM,CAAA;QAC5B,CAAQ,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,EAAE,CAAA;CACJ,CACF;;;;;;;;;;oBAQU,CAAC,IACD,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,CAAC,CAAC;CACV,CAAC;mBAGQ,CAAC,IACD,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC;mBAGvF,CAAC,IACD,CAAC,UAAU,EAAE,WAAW,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;;;;8BAK/E,CAAC,OAAO,SAAS,GAAG,eAAe,CAAC;;;;2BACpC,MAAM,IAAI;;;;4BACV,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI;;;;4BAC3B,CAAC,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,KAAK,IAAI;;;;8BACnF,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI;;;;yCACtC,CAAC;IACT,IAAI,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,CAAA;IAC9B,KAAK,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,CAAA;IAChC,KAAK,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,CAAA;IAChC,OAAO,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,CAAA;CACrC,CAAC;;;;8BACQ,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc;;;;gCACpD,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAoC1C,MAAM,KAAK,MAAM;;;;;;;;;;;6BAWjB,MAAM,KAAK,MAAM;;;;;;;;;;qBASlB,MAAM,OAAO,MAAM,QAAQ,GAAG,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BAiCxC,OAAO,CAAC,IAAI,CAAC;;mCAzJuD,aAAa;oCAAb,aAAa;oCAAb,aAAa;gCAAb,aAAa;gCAAb,aAAa;0BA1B5E,YAAY"}

package/priv/static/types/utils.d.ts

@@ -0,0 +1,2 @@
+export function closure<T>(value: T | (() => T)): () => T;
+//# sourceMappingURL=utils.d.ts.map

package/priv/static/types/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../assets/js/phoenix/utils.js"],"names":[],"mappings":"AAQO,wBAJK,CAAC,SACH,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GACX,MAAM,CAAC,CASlB"}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "include": [
+    "assets/js/phoenix/**/*.js"
+  ],
+  "compilerOptions": {
+    "target": "es2016",                       /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "module": "ESNext",                       /* Specify what module code is generated. */
+    "moduleResolution": "bundler",            /* Specify how TypeScript looks up a file from a given module specifier. */
+    "rootDir": "./assets/js/phoenix",         /* Specify the root folder within your source files. */
+    "allowJs": true,                          /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    "declaration": true,                      /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declarationMap": true,                   /* Create sourcemaps for d.ts files. */
+    "emitDeclarationOnly": true,              /* Only output d.ts files and not JavaScript files. */
+    "outDir": "./priv/static/types",          /* Specify an output folder for all emitted files. */
+    "esModuleInterop": true,                  /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "skipLibCheck": true                      /* Skip type checking all .d.ts files. */
+  }
+}