manifest/context

Classes

ManifestContext

Defined in: platform-utils/src/manifest/context.ts:158

Constructors

Constructor

new ManifestContext(input): ManifestContext;

Defined in: platform-utils/src/manifest/context.ts:164

Parameters

Parameter	Type
`input`	`ManifestContextInput`

Returns

ManifestContext

Accessors

manifest

Get Signature

get manifest(): NorbitalManifest;

Defined in: platform-utils/src/manifest/context.ts:181

Returns

NorbitalManifest

nodeId

Get Signature

get nodeId(): string;

Defined in: platform-utils/src/manifest/context.ts:185

Returns

string

recordIdKey

Get Signature

get recordIdKey(): string;

Defined in: platform-utils/src/manifest/context.ts:193

Returns

string

Methods

collectionExists()

collectionExists(collectionName): boolean;

Defined in: platform-utils/src/manifest/context.ts:308

Parameters

Parameter	Type
`collectionName`	`string`

Returns

boolean

columnsFor()

columnsFor(collectionName): CollectionColumnMap;

Defined in: platform-utils/src/manifest/context.ts:189

Parameters

Parameter	Type
`collectionName`	`string`

Returns

CollectionColumnMap

findApp()

findApp(appName): 
  | ManifestApp
  | null;

Defined in: platform-utils/src/manifest/context.ts:263

Parameters

Parameter	Type
`appName`	`string`

Returns

| ManifestApp | null

findAppUiModule()

findAppUiModule(appName): 
  | {
  app: ManifestApp;
  path: string[];
  uiModule: TUiModuleRef;
}
  | null;

Defined in: platform-utils/src/manifest/context.ts:267

Parameters

Parameter	Type
`appName`	`string`

Returns

| { app: ManifestApp; path: string[]; uiModule: TUiModuleRef; } | null

findCollection()

findCollection(name): 
  | ManifestCollectionEntry
  | null;

Defined in: platform-utils/src/manifest/context.ts:259

Parameters

Parameter	Type
`name`	`string`

Returns

| ManifestCollectionEntry | null

findRelationship()

findRelationship(relName): 
  | ManifestRelationship
  | null;

Defined in: platform-utils/src/manifest/context.ts:241

Parameters

Parameter	Type
`relName`	`string`

Returns

| ManifestRelationship | null

getApps()

getApps(): ManifestApp[];

Defined in: platform-utils/src/manifest/context.ts:205

Returns

ManifestApp[]

getAppsRecord()

getAppsRecord(): Record<string, TApp>;

Defined in: platform-utils/src/manifest/context.ts:209

Returns

Record<string, TApp>

getCollection()

getCollection(collectionName): ManifestCollectionEntry;

Defined in: platform-utils/src/manifest/context.ts:316

Parameters

Parameter	Type
`collectionName`	`string`

Returns

ManifestCollectionEntry

getCollections()

getCollections(): ManifestCollectionEntry[];

Defined in: platform-utils/src/manifest/context.ts:197

Returns

ManifestCollectionEntry[]

getCollectionsRecord()

getCollectionsRecord(): Record<string, TCollectionMetadata>;

Defined in: platform-utils/src/manifest/context.ts:201

Returns

Record<string, TCollectionMetadata>

getCollectionTitle()

getCollectionTitle(collectionName): string;

Defined in: platform-utils/src/manifest/context.ts:284

Parameters

Parameter	Type
`collectionName`	`string`

Returns

string

getEnvPublic()

getEnvPublic(): Record<string, string>;

Defined in: platform-utils/src/manifest/context.ts:297

Returns

Record<string, string>

getRecordDisplayLabel()

getRecordDisplayLabel(record, collectionNameOrId): object;

Defined in: platform-utils/src/manifest/context.ts:289

Parameters

Parameter	Type
`record`	`Record`<`string`, `unknown`>
`collectionNameOrId`	`string`

Returns

object

isFallback

isFallback: boolean;

text

text: string;

getRelationship()

getRelationship(relName): ManifestRelationship;

Defined in: platform-utils/src/manifest/context.ts:233

Parameters

Parameter	Type
`relName`	`string`

Returns

ManifestRelationship

getRelationships()

getRelationships(): ManifestRelationship[];

Defined in: platform-utils/src/manifest/context.ts:213

Returns

ManifestRelationship[]

getRelationshipsForCollection()

getRelationshipsForCollection(collectionName): object[];

Defined in: platform-utils/src/manifest/context.ts:221

Parameters

Parameter	Type
`collectionName`	`string`

Returns

object[]

listCollectionNames()

listCollectionNames(): string[];

Defined in: platform-utils/src/manifest/context.ts:312

Returns

string[]

replaceManifest()

replaceManifest(manifest): void;

Defined in: platform-utils/src/manifest/context.ts:176

Parameters

Parameter	Type
`manifest`	`NorbitalManifest`

Returns

void

stripSecretsForClient()

stripSecretsForClient(): NorbitalManifest;

Defined in: platform-utils/src/manifest/context.ts:301

Returns

NorbitalManifest

getRelationshipDirection()

static getRelationshipDirection(rel, currentCollection): object;

Defined in: platform-utils/src/manifest/context.ts:245

Parameters

Parameter	Type
`rel`	`ManifestRelationship`
`currentCollection`	`string`

Returns

object

isForward

isForward: boolean;

otherCollection

otherCollection: string;

Interfaces

CollectionColumn

Defined in: platform-utils/src/manifest/context.ts:12

Properties

array?

readonly optional array?: boolean;

Defined in: platform-utils/src/manifest/context.ts:15

currencies?

readonly optional currencies?: readonly string[];

Defined in: platform-utils/src/manifest/context.ts:17

dataType

readonly dataType: string;

Defined in: platform-utils/src/manifest/context.ts:13

mimeTypes?

readonly optional mimeTypes?: readonly string[];

Defined in: platform-utils/src/manifest/context.ts:18

notNull

readonly notNull: boolean;

Defined in: platform-utils/src/manifest/context.ts:14

values?

readonly optional values?: readonly string[];

Defined in: platform-utils/src/manifest/context.ts:16

variant?

readonly optional variant?: NumericRendererVariant;

Defined in: platform-utils/src/manifest/context.ts:19

Type Aliases

CollectionColumnMap

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

Defined in: platform-utils/src/manifest/context.ts:22