delete untracked api.json and stale api-report.md files (#3619)
We don't need these ### Change Type - [x] `internal` — Does not affect user-facing stuff - [x] `chore` — Updating dependencies, other boring stuff
This commit is contained in:
alex
GitHub
parent
77f19ccf8e
commit
e03328faf3
3 changed files with 0 additions and 30067 deletions
|
|
@ -1,232 +0,0 @@
|
|||
## API Report File for "@tldraw/assets"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
// @public (undocumented)
|
||||
export function getBundlerAssetUrls(opts?: AssetUrlOptions): {
|
||||
readonly fonts: {
|
||||
readonly monospace: string;
|
||||
readonly sansSerif: string;
|
||||
readonly serif: string;
|
||||
readonly draw: string;
|
||||
};
|
||||
readonly icons: {
|
||||
readonly 'align-bottom-center': string;
|
||||
readonly 'align-bottom-left': string;
|
||||
readonly 'align-bottom-right': string;
|
||||
readonly 'align-bottom': string;
|
||||
readonly 'align-center-center': string;
|
||||
readonly 'align-center-horizontal': string;
|
||||
readonly 'align-center-left': string;
|
||||
readonly 'align-center-right': string;
|
||||
readonly 'align-center-vertical': string;
|
||||
readonly 'align-left': string;
|
||||
readonly 'align-right': string;
|
||||
readonly 'align-top-center': string;
|
||||
readonly 'align-top-left': string;
|
||||
readonly 'align-top-right': string;
|
||||
readonly 'align-top': string;
|
||||
readonly 'arrow-left': string;
|
||||
readonly 'arrowhead-arrow': string;
|
||||
readonly 'arrowhead-bar': string;
|
||||
readonly 'arrowhead-diamond': string;
|
||||
readonly 'arrowhead-dot': string;
|
||||
readonly 'arrowhead-none': string;
|
||||
readonly 'arrowhead-square': string;
|
||||
readonly 'arrowhead-triangle-inverted': string;
|
||||
readonly 'arrowhead-triangle': string;
|
||||
readonly 'aspect-ratio': string;
|
||||
readonly avatar: string;
|
||||
readonly blob: string;
|
||||
readonly 'bring-forward': string;
|
||||
readonly 'bring-to-front': string;
|
||||
readonly check: string;
|
||||
readonly 'checkbox-checked': string;
|
||||
readonly 'checkbox-empty': string;
|
||||
readonly 'chevron-down': string;
|
||||
readonly 'chevron-left': string;
|
||||
readonly 'chevron-right': string;
|
||||
readonly 'chevron-up': string;
|
||||
readonly 'chevrons-ne': string;
|
||||
readonly 'chevrons-sw': string;
|
||||
readonly 'clipboard-copy': string;
|
||||
readonly code: string;
|
||||
readonly collab: string;
|
||||
readonly color: string;
|
||||
readonly comment: string;
|
||||
readonly 'cross-2': string;
|
||||
readonly cross: string;
|
||||
readonly 'dash-dashed': string;
|
||||
readonly 'dash-dotted': string;
|
||||
readonly 'dash-draw': string;
|
||||
readonly 'dash-solid': string;
|
||||
readonly discord: string;
|
||||
readonly 'distribute-horizontal': string;
|
||||
readonly 'distribute-vertical': string;
|
||||
readonly dot: string;
|
||||
readonly 'dots-horizontal': string;
|
||||
readonly 'dots-vertical': string;
|
||||
readonly 'drag-handle-dots': string;
|
||||
readonly duplicate: string;
|
||||
readonly edit: string;
|
||||
readonly 'external-link': string;
|
||||
readonly file: string;
|
||||
readonly 'fill-none': string;
|
||||
readonly 'fill-pattern': string;
|
||||
readonly 'fill-semi': string;
|
||||
readonly 'fill-solid': string;
|
||||
readonly follow: string;
|
||||
readonly following: string;
|
||||
readonly 'font-draw': string;
|
||||
readonly 'font-mono': string;
|
||||
readonly 'font-sans': string;
|
||||
readonly 'font-serif': string;
|
||||
readonly 'geo-arrow-down': string;
|
||||
readonly 'geo-arrow-left': string;
|
||||
readonly 'geo-arrow-right': string;
|
||||
readonly 'geo-arrow-up': string;
|
||||
readonly 'geo-check-box': string;
|
||||
readonly 'geo-diamond': string;
|
||||
readonly 'geo-ellipse': string;
|
||||
readonly 'geo-hexagon': string;
|
||||
readonly 'geo-octagon': string;
|
||||
readonly 'geo-oval': string;
|
||||
readonly 'geo-pentagon': string;
|
||||
readonly 'geo-rectangle': string;
|
||||
readonly 'geo-rhombus-2': string;
|
||||
readonly 'geo-rhombus': string;
|
||||
readonly 'geo-star': string;
|
||||
readonly 'geo-trapezoid': string;
|
||||
readonly 'geo-triangle': string;
|
||||
readonly 'geo-x-box': string;
|
||||
readonly github: string;
|
||||
readonly group: string;
|
||||
readonly hidden: string;
|
||||
readonly image: string;
|
||||
readonly 'info-circle': string;
|
||||
readonly leading: string;
|
||||
readonly link: string;
|
||||
readonly 'lock-small': string;
|
||||
readonly lock: string;
|
||||
readonly menu: string;
|
||||
readonly minus: string;
|
||||
readonly mixed: string;
|
||||
readonly pack: string;
|
||||
readonly page: string;
|
||||
readonly plus: string;
|
||||
readonly 'question-mark-circle': string;
|
||||
readonly 'question-mark': string;
|
||||
readonly redo: string;
|
||||
readonly 'reset-zoom': string;
|
||||
readonly 'rotate-ccw': string;
|
||||
readonly 'rotate-cw': string;
|
||||
readonly ruler: string;
|
||||
readonly search: string;
|
||||
readonly 'send-backward': string;
|
||||
readonly 'send-to-back': string;
|
||||
readonly 'settings-horizontal': string;
|
||||
readonly 'settings-vertical-1': string;
|
||||
readonly 'settings-vertical': string;
|
||||
readonly 'share-1': string;
|
||||
readonly 'share-2': string;
|
||||
readonly 'size-extra-large': string;
|
||||
readonly 'size-large': string;
|
||||
readonly 'size-medium': string;
|
||||
readonly 'size-small': string;
|
||||
readonly 'spline-cubic': string;
|
||||
readonly 'spline-line': string;
|
||||
readonly 'stack-horizontal': string;
|
||||
readonly 'stack-vertical': string;
|
||||
readonly 'stretch-horizontal': string;
|
||||
readonly 'stretch-vertical': string;
|
||||
readonly 'text-align-center': string;
|
||||
readonly 'text-align-justify': string;
|
||||
readonly 'text-align-left': string;
|
||||
readonly 'text-align-right': string;
|
||||
readonly 'tool-arrow': string;
|
||||
readonly 'tool-embed': string;
|
||||
readonly 'tool-eraser': string;
|
||||
readonly 'tool-frame': string;
|
||||
readonly 'tool-hand': string;
|
||||
readonly 'tool-highlighter': string;
|
||||
readonly 'tool-line': string;
|
||||
readonly 'tool-media': string;
|
||||
readonly 'tool-note': string;
|
||||
readonly 'tool-pencil': string;
|
||||
readonly 'tool-pointer': string;
|
||||
readonly 'tool-text': string;
|
||||
readonly trash: string;
|
||||
readonly 'triangle-down': string;
|
||||
readonly 'triangle-up': string;
|
||||
readonly twitter: string;
|
||||
readonly undo: string;
|
||||
readonly ungroup: string;
|
||||
readonly 'unlock-small': string;
|
||||
readonly unlock: string;
|
||||
readonly visible: string;
|
||||
readonly 'warning-triangle': string;
|
||||
readonly 'zoom-in': string;
|
||||
readonly 'zoom-out': string;
|
||||
};
|
||||
readonly translations: {
|
||||
readonly ar: string;
|
||||
readonly ca: string;
|
||||
readonly da: string;
|
||||
readonly de: string;
|
||||
readonly en: string;
|
||||
readonly es: string;
|
||||
readonly fa: string;
|
||||
readonly fi: string;
|
||||
readonly fr: string;
|
||||
readonly gl: string;
|
||||
readonly he: string;
|
||||
readonly 'hi-in': string;
|
||||
readonly hu: string;
|
||||
readonly it: string;
|
||||
readonly ja: string;
|
||||
readonly 'ko-kr': string;
|
||||
readonly ku: string;
|
||||
readonly languages: string;
|
||||
readonly main: string;
|
||||
readonly my: string;
|
||||
readonly ne: string;
|
||||
readonly no: string;
|
||||
readonly pl: string;
|
||||
readonly 'pt-br': string;
|
||||
readonly 'pt-pt': string;
|
||||
readonly ro: string;
|
||||
readonly ru: string;
|
||||
readonly sv: string;
|
||||
readonly te: string;
|
||||
readonly th: string;
|
||||
readonly tr: string;
|
||||
readonly uk: string;
|
||||
readonly vi: string;
|
||||
readonly 'zh-cn': string;
|
||||
readonly 'zh-tw': string;
|
||||
};
|
||||
readonly embedIcons: {
|
||||
readonly codepen: string;
|
||||
readonly codesandbox: string;
|
||||
readonly excalidraw: string;
|
||||
readonly felt: string;
|
||||
readonly figma: string;
|
||||
readonly github_gist: string;
|
||||
readonly google_calendar: string;
|
||||
readonly google_maps: string;
|
||||
readonly google_slides: string;
|
||||
readonly observable: string;
|
||||
readonly replit: string;
|
||||
readonly scratch: string;
|
||||
readonly spotify: string;
|
||||
readonly tldraw: string;
|
||||
readonly vimeo: string;
|
||||
readonly youtube: string;
|
||||
};
|
||||
};
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,296 +0,0 @@
|
|||
## API Report File for "@tldraw/tlsync"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { Atom } from 'signia';
|
||||
import { BaseRecord } from '@tldraw/tlstore';
|
||||
import { MigrationFailureReason } from '@tldraw/tlstore';
|
||||
import { RecordsDiff } from '@tldraw/tlstore';
|
||||
import { RecordType } from '@tldraw/tlstore';
|
||||
import { Result } from '@tldraw/utils';
|
||||
import { SerializedSchema } from '@tldraw/tlstore';
|
||||
import { Signal } from 'signia';
|
||||
import { Store } from '@tldraw/tlstore';
|
||||
import { StoreSchema } from '@tldraw/tlstore';
|
||||
import * as WebSocket_2 from 'ws';
|
||||
|
||||
// @public (undocumented)
|
||||
export type AppendOp = [type: ValueOpType.Append, values: unknown[], offset: number];
|
||||
|
||||
// @public (undocumented)
|
||||
export function applyObjectDiff<T extends object>(object: T, objectDiff: ObjectDiff): T;
|
||||
|
||||
// @public (undocumented)
|
||||
export type DeleteOp = [type: ValueOpType.Delete];
|
||||
|
||||
// @public (undocumented)
|
||||
export function diffRecord(prev: object, next: object): null | ObjectDiff;
|
||||
|
||||
// @public
|
||||
export const getNetworkDiff: <R extends BaseRecord<string>>(diff: RecordsDiff<R>) => NetworkDiff<R> | null;
|
||||
|
||||
// @public
|
||||
export type NetworkDiff<R extends BaseRecord> = {
|
||||
[id: string]: RecordOp<R>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type ObjectDiff = {
|
||||
[k: string]: ValueOp;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type PatchOp = [type: ValueOpType.Patch, diff: ObjectDiff];
|
||||
|
||||
// @public (undocumented)
|
||||
export type PersistedRoomSnapshot = {
|
||||
id: string;
|
||||
slug: string;
|
||||
drawing: RoomSnapshot;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type PutOp = [type: ValueOpType.Put, value: unknown];
|
||||
|
||||
// @public (undocumented)
|
||||
export type RecordOp<R extends BaseRecord> = [RecordOpType.Patch, ObjectDiff] | [RecordOpType.Put, R] | [RecordOpType.Remove];
|
||||
|
||||
// @public (undocumented)
|
||||
export enum RecordOpType {
|
||||
// (undocumented)
|
||||
Patch = "patch",
|
||||
// (undocumented)
|
||||
Put = "put",
|
||||
// (undocumented)
|
||||
Remove = "remove"
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type RoomClient<R extends BaseRecord> = {
|
||||
serializedSchema: SerializedSchema;
|
||||
socket: TLRoomSocket<R>;
|
||||
id: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type RoomForId = {
|
||||
id: string;
|
||||
persistenceId?: string;
|
||||
timeout?: any;
|
||||
room: TLSyncRoom<any>;
|
||||
clients: Map<WebSocket_2.WebSocket, RoomClient<any>>;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type RoomSnapshot = {
|
||||
clock: number;
|
||||
documents: Array<{
|
||||
state: BaseRecord;
|
||||
lastChangedClock: number;
|
||||
}>;
|
||||
tombstones?: Record<string, number>;
|
||||
schema?: SerializedSchema;
|
||||
};
|
||||
|
||||
// @public
|
||||
export function serializeMessage(message: Message): string;
|
||||
|
||||
// @public (undocumented)
|
||||
export type TLConnectRequest = {
|
||||
type: 'connect';
|
||||
lastServerClock: number;
|
||||
protocolVersion: number;
|
||||
schema: SerializedSchema;
|
||||
instanceId: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export enum TLIncompatibilityReason {
|
||||
// (undocumented)
|
||||
ClientTooOld = "clientTooOld",
|
||||
// (undocumented)
|
||||
InvalidOperation = "invalidOperation",
|
||||
// (undocumented)
|
||||
InvalidRecord = "invalidRecord",
|
||||
// (undocumented)
|
||||
ServerTooOld = "serverTooOld"
|
||||
}
|
||||
|
||||
// @public
|
||||
export type TLPersistentClientSocket<R extends BaseRecord = BaseRecord> = {
|
||||
connectionStatus: 'error' | 'offline' | 'online';
|
||||
sendMessage: (msg: TLSocketClientSentEvent<R>) => void;
|
||||
onReceiveMessage: SubscribingFn<TLSocketServerSentEvent<R>>;
|
||||
onStatusChange: SubscribingFn<TLPersistentClientSocketStatus>;
|
||||
restart: () => void;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type TLPersistentClientSocketStatus = 'error' | 'offline' | 'online';
|
||||
|
||||
// @public (undocumented)
|
||||
export type TLPingRequest = {
|
||||
type: 'ping';
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type TLPushRequest<R extends BaseRecord> = {
|
||||
type: 'push';
|
||||
clientClock: number;
|
||||
diff: NetworkDiff<R>;
|
||||
} | {
|
||||
type: 'push';
|
||||
clientClock: number;
|
||||
presence: [RecordOpType.Patch, ObjectDiff] | [RecordOpType.Put, R];
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type TLRoomSocket<R extends BaseRecord> = {
|
||||
isOpen: boolean;
|
||||
sendMessage: (msg: TLSocketServerSentEvent<R>) => void;
|
||||
};
|
||||
|
||||
// @public
|
||||
export abstract class TLServer {
|
||||
abstract deleteRoomForId(roomId: string): void;
|
||||
abstract getRoomForId(roomId: string): RoomForId | undefined;
|
||||
handleConnection: (ws: WebSocket_2.WebSocket, roomId: string) => Promise<void>;
|
||||
loadFromDatabase?(roomId: string): Promise<PersistedRoomSnapshot | undefined>;
|
||||
logEvent?(_event: {
|
||||
roomId: string;
|
||||
name: string;
|
||||
clientId?: string;
|
||||
}): void;
|
||||
persistToDatabase?(roomId: string): Promise<void>;
|
||||
abstract setRoomForId(roomId: string, roomForId: RoomForId): void;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type TLSocketClientSentEvent<R extends BaseRecord> = TLConnectRequest | TLPingRequest | TLPushRequest<R>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type TLSocketServerSentEvent<R extends BaseRecord> = {
|
||||
type: 'connect';
|
||||
hydrationType: 'wipe_all' | 'wipe_presence';
|
||||
protocolVersion: number;
|
||||
schema: SerializedSchema;
|
||||
diff: NetworkDiff<R>;
|
||||
serverClock: number;
|
||||
} | {
|
||||
type: 'error';
|
||||
error?: any;
|
||||
} | {
|
||||
type: 'incompatibility_error';
|
||||
reason: TLIncompatibilityReason;
|
||||
} | {
|
||||
type: 'patch';
|
||||
diff: NetworkDiff<R>;
|
||||
serverClock: number;
|
||||
} | {
|
||||
type: 'pong';
|
||||
} | {
|
||||
type: 'push_result';
|
||||
clientClock: number;
|
||||
serverClock: number;
|
||||
action: 'commit' | 'discard' | {
|
||||
rebaseWithDiff: NetworkDiff<R>;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const TLSYNC_PROTOCOL_VERSION = 3;
|
||||
|
||||
// @public
|
||||
export class TLSyncClient<R extends BaseRecord, S extends Store<R> = Store<R>> {
|
||||
constructor(config: {
|
||||
store: S;
|
||||
socket: TLPersistentClientSocket<R>;
|
||||
instanceId: string;
|
||||
onLoad: (self: TLSyncClient<R, S>) => void;
|
||||
onLoadError: (error: Error) => void;
|
||||
onSyncError: (reason: TLIncompatibilityReason) => void;
|
||||
onAfterConnect?: (self: TLSyncClient<R, S>) => void;
|
||||
});
|
||||
// (undocumented)
|
||||
close(): void;
|
||||
// (undocumented)
|
||||
incomingDiffBuffer: Extract<TLSocketServerSentEvent<R>, {
|
||||
type: 'patch' | 'push_result';
|
||||
}>[];
|
||||
readonly instanceId: string;
|
||||
// (undocumented)
|
||||
isConnectedToRoom: boolean;
|
||||
// (undocumented)
|
||||
lastPushedPresenceState: null | R;
|
||||
readonly onAfterConnect?: (self: TLSyncClient<R, S>) => void;
|
||||
// (undocumented)
|
||||
readonly onSyncError: (reason: TLIncompatibilityReason) => void;
|
||||
// (undocumented)
|
||||
readonly presenceState: Signal<null | R>;
|
||||
// (undocumented)
|
||||
readonly socket: TLPersistentClientSocket<R>;
|
||||
// (undocumented)
|
||||
readonly store: S;
|
||||
}
|
||||
|
||||
// @public
|
||||
export class TLSyncRoom<R extends BaseRecord> {
|
||||
constructor(schema: StoreSchema<R>, snapshot?: RoomSnapshot);
|
||||
addClient(client: RoomClient<R>): void;
|
||||
broadcastPatch({ diff, sourceClient }: {
|
||||
diff: NetworkDiff<R>;
|
||||
sourceClient: RoomClient<R>;
|
||||
}): this;
|
||||
// (undocumented)
|
||||
clientIdsToInstanceIds: Map<string, string>;
|
||||
// (undocumented)
|
||||
clients: Map<string, RoomClient<R>>;
|
||||
// (undocumented)
|
||||
clock: number;
|
||||
// (undocumented)
|
||||
readonly documentTypes: Set<string>;
|
||||
// (undocumented)
|
||||
getSnapshot(): RoomSnapshot;
|
||||
handleClose: (client: RoomClient<R>) => void;
|
||||
handleConnection: (client: RoomClient<R>) => this;
|
||||
handleMessage: (client: RoomClient<R>, message: TLSocketClientSentEvent<R>) => Promise<this | void>;
|
||||
migrateDiffForClient(client: RoomClient<R>, diff: NetworkDiff<R>): Result<NetworkDiff<R>, MigrationFailureReason>;
|
||||
// (undocumented)
|
||||
readonly presenceType: RecordType<R, any>;
|
||||
// (undocumented)
|
||||
pruneTombstones(): void;
|
||||
removeClient(client: RoomClient<R>): void;
|
||||
// (undocumented)
|
||||
readonly schema: StoreSchema<R>;
|
||||
sendMessageToClient(client: RoomClient<R>, message: TLSocketServerSentEvent<R>): this;
|
||||
// (undocumented)
|
||||
readonly serializedSchema: SerializedSchema;
|
||||
// (undocumented)
|
||||
state: Atom<{
|
||||
documents: Record<string, DocumentState<R>>;
|
||||
tombstones: Record<string, number>;
|
||||
}, unknown>;
|
||||
// (undocumented)
|
||||
tombstoneHistoryStartsAtClock: number;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type ValueOp = AppendOp | DeleteOp | PatchOp | PutOp;
|
||||
|
||||
// @public (undocumented)
|
||||
export enum ValueOpType {
|
||||
// (undocumented)
|
||||
Append = "append",
|
||||
// (undocumented)
|
||||
Delete = "delete",
|
||||
// (undocumented)
|
||||
Patch = "patch",
|
||||
// (undocumented)
|
||||
Put = "put"
|
||||
}
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
Loading…
Reference in a new issue