client/public

Classes

DetailSurfaceService

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:25

Constructors

Constructor

new DetailSurfaceService(options?): DetailSurfaceService;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:32

Parameters

Parameter	Type
`options?`	`DetailSurfaceServiceOptions`

Returns

DetailSurfaceService

Methods

applyNavState()

applyNavState(url, next): void;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:180

Parameters

Parameter	Type
`url`	`URL`
`next`	{ `stack`: `object`[]; }
`next.stack`	`object`[]

Returns

void

generateNextUrl()

generateNextUrl(url, stackItem): string;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:129

Parameters

Parameter	Type
`url`	`URL`
`stackItem`	{ `collection_name`: `string`; `node_id`: `string`; `record_id`: `string`; `viewMode`: `"page"` \| `"sidesheet"`; `with?`: { [`key`: `string`]: `unknown`; }; }
`stackItem.collection_name`	`string`
`stackItem.node_id`	`string`
`stackItem.record_id`	`string`
`stackItem.viewMode`	`"page"` \| `"sidesheet"`
`stackItem.with?`	{ [`key`: `string`]: `unknown`; }

Returns

string

generatePreviousUrl()

generatePreviousUrl(url): string;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:163

Parameters

Parameter	Type
`url`	`URL`

Returns

string

generateUrlAtIndex()

generateUrlAtIndex(url, index): string;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:134

Parameters

Parameter	Type
`url`	`URL`
`index`	`number`

Returns

string

generateUrlForTargets()

generateUrlForTargets(url, targets): string;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:90

Parameters

Parameter	Type
`url`	`URL`
`targets`	`object`[]

Returns

string

getCurrentNavStack()

getCurrentNavStack(url): 
  | {
  stack: object[];
}
  | null;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:72

Reads ?stack=; writes go through navigateToTargets, applyNavState, or urlForNavState.

Parameters

Parameter	Type
`url`	`URL`

Returns

| { stack: object[]; } | null

getCurrentSelection()

getCurrentSelection(url): 
  | {
  collection_name: string;
  node_id: string;
  record_id: string;
  viewMode: "page" | "sidesheet";
  with?: {
   [key: string]: unknown;
  };
}
  | null;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:76

Parameters

Parameter	Type
`url`	`URL`

Returns

| { collection_name: string; node_id: string; record_id: string; viewMode: "page" | "sidesheet"; with?: { [key: string]: unknown; }; } | null

navigateToTargets()

navigateToTargets(url, targets): void;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:112

Parameters

Parameter	Type
`url`	`URL`
`targets`	`object`[]

Returns

void

pop()

pop(url): void;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:176

Parameters

Parameter	Type
`url`	`URL`

Returns

void

register()

register(input): () => void;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:44

Parameters

Parameter	Type
`input`	`CollectionTableDetailRegistration`

Returns

() => void

replaceTargetByRouteKey()

replaceTargetByRouteKey(currentStack, params): object[];

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:116

Parameters

Parameter	Type
`currentStack`	`object`[]
`params`	{ `nextTarget`: { `collection_name`: `string`; `node_id`: `string`; `record_id`: `string`; `viewMode`: `"page"` \| `"sidesheet"`; `with?`: { [`key`: `string`]: `unknown`; }; }; `routeKey`: `string`; }
`params.nextTarget`	{ `collection_name`: `string`; `node_id`: `string`; `record_id`: `string`; `viewMode`: `"page"` \| `"sidesheet"`; `with?`: { [`key`: `string`]: `unknown`; }; }
`params.nextTarget.collection_name`	`string`
`params.nextTarget.node_id`	`string`
`params.nextTarget.record_id`	`string`
`params.nextTarget.viewMode`	`"page"` \| `"sidesheet"`
`params.nextTarget.with?`	{ [`key`: `string`]: `unknown`; }
`params.routeKey`	`string`

Returns

object[]

resolve()

resolve(routeKey, parentRouteKey?): 
  | CollectionTableDetailRegistration
  | undefined;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:58

Parameters

Parameter	Type
`routeKey`	`string`
`parentRouteKey?`	`string`

Returns

| CollectionTableDetailRegistration | undefined

toNavigationTargets()

toNavigationTargets(stack): object[];

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:80

Parameters

Parameter	Type
`stack`	`object`[]

Returns

object[]

urlForNavState()

urlForNavState(url, next): string;

Defined in: pod/src/lib/client/subservices/detail_surface.service.ts:187

Canonical ?stack= URL for a validated nav state (e.g. task detail hrefs).

Parameters

Parameter	Type
`url`	`URL`
`next`	{ `stack`: `object`[]; }
`next.stack`	`object`[]

Returns

string

WorkspaceFileUploadClient

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:44

Implements

IFileUploadClient

Constructors

Constructor

new WorkspaceFileUploadClient(): WorkspaceFileUploadClient;

Returns

WorkspaceFileUploadClient

Properties

uploads

readonly uploads: UploadEntry[];

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:45

Implementation of

IFileUploadClient.uploads

Methods

beginUpload()

beginUpload(file, options?): object;

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:64

Parameters

Parameter	Type
`file`	`File`
`options?`	`BeginUploadOptions`

Returns

object

id

id: string;

promise

promise: Promise<UploadResult>;

Implementation of

IFileUploadClient.beginUpload

cancel()

cancel(entryId): void;

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:125

Parameters

Parameter	Type
`entryId`	`string`

Returns

void

Implementation of

IFileUploadClient.cancel

clear()

clear(entryId): void;

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:129

Remove a finished or errored entry from the uploads list (cancels if still in flight).

Parameters

Parameter	Type
`entryId`	`string`

Returns

void

Implementation of

IFileUploadClient.clear

clearAllUploads()

clearAllUploads(): void;

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:135

Returns

void

Implementation of

IFileUploadClient.clearAllUploads

delete()

delete(fileUrl): Promise<void>;

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:111

Parameters

Parameter	Type
`fileUrl`	`string`

Returns

Promise<void>

Implementation of

IFileUploadClient.delete

upload()

upload(file, options?): Promise<UploadResult>;

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:49

Parameters

Parameter	Type
`file`	`File`
`options?`	`UploadOptions`

Returns

Promise<UploadResult>

Implementation of

IFileUploadClient.upload

uploadMany()

uploadMany(files, options?): Promise<UploadResult[]>;

Defined in: pod/src/lib/client/workspace-file-upload.svelte.ts:53

Parameters

Parameter	Type
`files`	`File`[]
`options?`	`Pick`<`UploadOptions`, `"stream"`>

Returns

Promise<UploadResult[]>

Implementation of

IFileUploadClient.uploadMany

Interfaces

CollectionExportDownloadOptions

Defined in: pod/src/lib/client/collection-export.ts:20

Properties

includeAction?

readonly optional includeAction?: (action) => boolean;

Defined in: pod/src/lib/client/collection-export.ts:21

Parameters

Parameter	Type
`action`	`TExportAction`

Returns

boolean

SerializedExportAttachment

Defined in: pod/src/lib/client/collection-export.ts:14

Properties

body

readonly body: string | Uint8Array<ArrayBuffer>;

Defined in: pod/src/lib/client/collection-export.ts:17

mimeType

readonly mimeType: string;

Defined in: pod/src/lib/client/collection-export.ts:16

name

readonly name: string;

Defined in: pod/src/lib/client/collection-export.ts:15

Type Aliases

CollectionExportInput

type CollectionExportInput = Parameters<WorkspaceRemoteTransport["exportPipeline"]>[0];

Defined in: pod/src/lib/client/collection-export.ts:12

CollectionImportInput

type CollectionImportInput = Parameters<WorkspaceRemoteTransport["importPipeline"]>[0];

Defined in: pod/src/lib/client/collection-import.ts:7

ImportedCollectionRecord

type ImportedCollectionRecord = Readonly<Record<string, unknown>>;

Defined in: pod/src/lib/client/collection-import.ts:8

NavStackItem

type NavStackItem = z.infer<typeof NavStackItemSchema>;

Defined in: pod/src/lib/client/types.ts:93

WorkspaceCollectionClient

type WorkspaceCollectionClient<TCollections> = CollectionClient<TCollections>;

Defined in: pod/src/lib/runtime/client.ts:235

Type Parameters

Type Parameter
`TCollections` extends `CollectionRegistry`

WorkspaceCollectionColumns

type WorkspaceCollectionColumns = Readonly<Record<string, CollectionColumnMap>>;

Defined in: pod/src/lib/runtime/client.ts:234

Functions

createWorkspaceApiProxy()

function createWorkspaceApiProxy<S, TInvoke>(): WorkspaceClient<S, TInvoke>;

Defined in: pod/src/lib/runtime/client.ts:245

Type Parameters

Type Parameter
`S` extends `AnySchema`
`TInvoke` extends `Readonly`<`Record`<`string`, `HandlerDefinition`>>

Returns

WorkspaceClient<S, TInvoke>

createWorkspaceCollectionClient()

function createWorkspaceCollectionClient<TCollections>(columns, manifest): WorkspaceCollectionClient<TCollections>;

Defined in: pod/src/lib/runtime/client.ts:273

Type Parameters

Type Parameter
`TCollections` extends `Readonly`<`Record`<`string`, `CollectionType`<`object`, `object`, `object`>>>

Parameters

Parameter	Type
`columns`	`WorkspaceCollectionColumns`
`manifest`	`NorbitalManifest`

Returns

WorkspaceCollectionClient<TCollections>

downloadCollectionExport()

function downloadCollectionExport(input, options?): Promise<TExportManifest>;

Defined in: pod/src/lib/client/collection-export.ts:130

Parameters

Parameter	Type
`input`	{ `bypass_secret?`: `string`; `collection_name`: `string`; `record_ids?`: `string`[]; `where?`: `RelationsFilterColumns`<`any`> & `RelationsFilterRelations`<`TableRelationalConfig`, `TablesRelationalConfig`, `RelationsRecord`> & `RelationsFilterCommons`<`TableRelationalConfig`, `TablesRelationalConfig`>; `with?`: `Record`<`string`, `AnyDBQueryConfig`>; }
`input.bypass_secret?`	`string`
`input.collection_name`	`string`
`input.record_ids?`	`string`[]
`input.where?`	`RelationsFilterColumns`<`any`> & `RelationsFilterRelations`<`TableRelationalConfig`, `TablesRelationalConfig`, `RelationsRecord`> & `RelationsFilterCommons`<`TableRelationalConfig`, `TablesRelationalConfig`>
`input.with?`	`Record`<`string`, `AnyDBQueryConfig`>
`options`	`CollectionExportDownloadOptions`

Returns

Promise<TExportManifest>

getPlatformStateContext()

function getPlatformStateContext(): () => PlatformState;

Defined in: pod/src/lib/client/platform_state.svelte.ts:18

Returns

() => PlatformState

getWorkspaceClientContext()

function getWorkspaceClientContext(): WorkspaceClient;

Defined in: pod/src/lib/client/workspace_client_context.ts:8

Returns

WorkspaceClient

importCollectionRecords()

function importCollectionRecords(input): Promise<readonly Readonly<Record<string, unknown>>[]>;

Defined in: pod/src/lib/client/collection-import.ts:12

Parameters

Parameter	Type
`input`	{ `bypass_secret?`: `string`; `collection_name`: `string`; `import_data`: `unknown`; }
`input.bypass_secret?`	`string`
`input.collection_name`	`string`
`input.import_data`	`unknown`

Returns

Promise<readonly Readonly<Record<string, unknown>>[]>

mergeCollectionDetailNavStack()

function mergeCollectionDetailNavStack(
   currentStack, 
   nextTarget, 
   routeKey, 
   routeContext, 
   replaceTargetByRouteKey, 
   parentRouteKey?): object[];

Defined in: pod/src/lib/client/utils/collection_detail_navigation.ts:25

Parameters

Parameter	Type
`currentStack`	readonly `object`[]
`nextTarget`	{ `collection_name`: `string`; `node_id`: `string`; `record_id`: `string`; `viewMode`: `"page"` \| `"sidesheet"`; `with?`: { [`key`: `string`]: `unknown`; }; }
`nextTarget.collection_name`	`string`
`nextTarget.node_id`	`string`
`nextTarget.record_id`	`string`
`nextTarget.viewMode`	`"page"` \| `"sidesheet"`
`nextTarget.with?`	{ [`key`: `string`]: `unknown`; }
`routeKey?`	`string`
`routeContext?`	`TRouteContext` \| `null`
`replaceTargetByRouteKey?`	(`currentStack`, `params`) => `object`[]
`parentRouteKey?`	`string`

Returns

object[]

References