Class AliasTrait

The URLAlias module manages the lifecycle of an entity's URL aliases. Lifecycle hooks such as:

preCreate
postCreate
preUpdate
postUpdate
postDelete

It provides granular control over alias creation, updates, and deletion. This ensures that each alias remains associated with its intended content while providing flexibility for dynamic URL restructuring.

Usage:

traits:
  - type: alias
    field: url_alias

Hierarchy

Trait<AliasTraitConfig>
- AliasTrait

Constructors

constructor

new AliasTrait(_runtimeConfig: RuntimeConfig, _graphqlSchemaManager: GraphQLSchemaManager, _dataSourceWrapper: DataSourceWrapper, _schemaManager: SchemaManager, db: NoSQLDatabase): AliasTrait
Parameters
- _runtimeConfig: RuntimeConfig
- _graphqlSchemaManager: GraphQLSchemaManager
- _dataSourceWrapper: DataSourceWrapper
- _schemaManager: SchemaManager
- db: NoSQLDatabase
Returns AliasTrait
Overrides Trait.constructor
- Defined in src/traits/AliasTrait.ts:63

Properties

`Protected` `Optional` _config

_config?: AliasTraitConfig

Trait instance configuration.

`Protected` `Readonly` _dataSourceWrapper

_dataSourceWrapper: DataSourceWrapper

`Protected` _global

_global: boolean = false

Whether this is a global (not bound to any specific schema item) trait instance.

`Protected` `Readonly` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

`Protected` _runtimeConfig

_runtimeConfig: RuntimeConfig

`Protected` `Readonly` _schemaManager

_schemaManager: SchemaManager

`Protected` `Optional` _type

_type?: "alias"

Trait type.

`Protected` db

db: NoSQLDatabase

field

field: undefined | string

logger

logger: Logger

tablename

tablename: string

Methods

`Protected` checkIfAliasExists

checkIfAliasExists(tenant: string, alias: string): Promise<boolean>
This internal function is used to retrieve an alias for a tenant

Returns
Parameters
- tenant: string
  
  This is the users tenant id.
- alias: string
  
  This is the url alias.
Returns Promise<boolean>
- Defined in src/traits/AliasTrait.ts:445

`Protected` createAlias

createAlias(tenant: string, alias: string, uuid: string, type: string): Promise<void>
This internal function is used to create an alias for a tenant.

Returns
Parameters
- tenant: string
  
  This is the users tenant id.
- alias: string
  
  This is the url alias.
- uuid: string
  
  This is the uuid of the entity.
- type: string
  
  This is the type of the entity.
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:466

`Protected` deleteByUUID

deleteByUUID(tenant: string, uuid: string): Promise<void>
This internal function is used to delete all aliases for a specified entity uuid, its used a DynamoDB GSI to find all the aliases for the entity.
Parameters
- tenant: string
  
  This is the users tenant id.
- uuid: string
  
  This is the uuid of the entity.
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:489

extractUrl

extractUrl(inputString: string): string
Extracts the URL part from a string in the format 'uuid#url'.

Returns
- The extracted URL part of the input string. If the input string does not contain '#', it returns an empty string.
Parameters
- inputString: string
  
  The input string containing a UUID and a URL separated by '#'.
Returns string
- Defined in src/traits/AliasTrait.ts:424

`Protected` getByUUID

getByUUID(tenant: string, uuid: string): Promise<undefined | string>
This internal function is used to retrieve an alias for a tenant

Returns
Parameters
- tenant: string
  
  This is the users tenant id.
- uuid: string
  
  This is the id of the entity.
Returns Promise<undefined | string>
- Defined in src/traits/AliasTrait.ts:518

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/AliasTrait.ts:270

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

`Protected` isValidPath

isValidPath(path: string): boolean
This internal function is used to validate the path of the alias.

Returns
boolean
Parameters
- path: string
  
  The path to validate.
Returns boolean
- Defined in src/traits/AliasTrait.ts:543

makeGlobal

makeGlobal(): AliasTrait
Makes this Trait instance global.

Returns AliasTrait
Inherited from Trait.makeGlobal
- Defined in src/traits/Trait.ts:237

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

postCreate

postCreate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: ItemWithId, legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
If the alias field exists, create the Alias entry as we now have the uuid of the entity that we have created.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object
- item: ItemWithId
  
  The item being created
- legacyDatasourceWrapper: DataSourceWrapper
  
  Datasource wrapper object.
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:145

postDelete

postDelete(_traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, entity: ItemWithId, _legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Clean up and handle consequences of the alias deletion.

Returns
Parameters
- _traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- entity: ItemWithId
- _legacyDatasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:251

postUpdate

postUpdate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: Record<string, any>, _legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
If the alias field has been updated then a new create the Alias entry

Returns
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  Used by traits for non user accessible entities
- item: Record<string, any>
  
  The item being updated.
- _legacyDatasourceWrapper: DataSourceWrapper
  
  Not used
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:215

postView

postView(item: Record<string, any>, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Post-view hook implementation, handles replacing the keyed data with the content from the storage engine

Returns
Parameters
- item: Record<string, any>
  
  The current item being retrieved
- datasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:330

preCreate

preCreate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, _legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Check if the alias has been populated, skip if empty, if not then ensure that the new alias does not conflict with existing ones.
- Validate the format and structure of the alias to make sure it conforms to your desired pattern.
- Check the DynamoDB table to ensure the alias doesn't already exist for the current tenant.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data.
- _legacyDatasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:119

preUpdate

preUpdate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, _data: Record<string, any>, _legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Check if the alias field has been changed, if so:
- Validate the format and structure of the alias to make sure it conforms to your desired pattern.
- Check the DynamoDB table to ensure the alias doesn't already exist for the current tenant.
Returns
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object
- _data: Record<string, any>
- _legacyDatasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:187

process

process<RT, Payload>(callbackName: string, datasourceWrapper: DataSourceWrapper, data: TraitDataObject<RT, Payload, Promise<any>>): Promise<RT>
This method is triggered when a trait callback has been activated
Type Parameters
- RT = any
- Payload = any
Parameters
- callbackName: string
  
  This is the name of the callback function to call.
- datasourceWrapper: DataSourceWrapper
  
  References to the Graph Hanlder
- data: TraitDataObject<RT, Payload, Promise<any>>
  
  Request data passed along as part of the request.
Returns Promise<RT>
Inherited from Trait.process
- Defined in src/traits/Trait.ts:147

`Private` retrieveAlias

retrieveAlias(item: Record<string, any>, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
This function is used to retrieve the alias for an item.

Returns
void
Parameters
- item: Record<string, any>
  
  The item which the alias is being retrieved for
- datasourceWrapper: DataSourceWrapper
  
  The datasource wrapper object
- context: KosmosUserContext<object>
  
  The user context
Returns Promise<void>
- Defined in src/traits/AliasTrait.ts:379

setConfig

setConfig(config: AliasTraitConfig): void
Configuration setter.
Parameters
- config: AliasTraitConfig
  
  The new configuration.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/AliasTrait.ts:87

traitConfig

traitConfig(): AliasTraitConfig
Returns AliasTraitConfig
Inherited from Trait.traitConfig
- Defined in src/traits/Trait.ts:205

urlAccess

urlAccess(...__namedParameters: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]): Promise<null | string>
This function is used as a resolver for the alias field.

NOTE: This function is not used in the current implementation. It's currently disabled as the postView hook is used to populate the alias, this is due to how the AncestorTrait retrieves data via the findVertex function.
Parameters
- Rest ...__namedParameters: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]
Returns Promise<null | string>
- Defined in src/traits/AliasTrait.ts:356

wrapLegacyResolver

wrapLegacyResolver<RT, Payload>(resolver: LegacyKosmosTraitResolverCallback<RT, any>, datasourceWrapper: DataSourceWrapper, callbackName?: string): KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Helper method for wrapping legacy Kosmos traits callbacks.

TODO: Remove this method once all Traits are converted.
Type Parameters
- RT = any
- Payload = any
Parameters
- resolver: LegacyKosmosTraitResolverCallback<RT, any>
- datasourceWrapper: DataSourceWrapper
- Optional callbackName: string
  
  Optional callback name; passing this parameter will additionally wrap the callback into legacy process().
Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Inherited from Trait.wrapLegacyResolver
- Defined in src/traits/Trait.ts:168

`Static` traitTypeName

traitTypeName(): string
This method should return the trait machine name(s).

Returns

Returns string
Overrides Trait.traitTypeName
- Defined in src/traits/AliasTrait.ts:101

Class AliasTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_runtimeConfig: RuntimeConfig

_graphqlSchemaManager: GraphQLSchemaManager

_dataSourceWrapper: DataSourceWrapper

_schemaManager: SchemaManager

db: NoSQLDatabase

Returns AliasTrait

Properties

Protected Optional _config

Protected Readonly _dataSourceWrapper

Protected _global

Protected Readonly _graphqlSchemaManager

Protected _runtimeConfig

Protected Readonly _schemaManager

Protected Optional _type

Protected db

field

logger

tablename

Methods

Protected checkIfAliasExists

Returns

Parameters

tenant: string

alias: string

Returns Promise<boolean>

Protected createAlias

Returns

Parameters

tenant: string

alias: string

uuid: string

type: string

Returns Promise<void>

Protected deleteByUUID

Parameters

tenant: string

uuid: string

Returns Promise<void>

extractUrl

Returns

Parameters

inputString: string

Returns string

Protected getByUUID

Returns

Parameters

tenant: string

uuid: string

Returns Promise<undefined | string>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

Protected isValidPath

Returns

Parameters

path: string

Returns boolean

makeGlobal

Returns AliasTrait

name

Returns string

postCreate

Parameters

traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>

item: ItemWithId

legacyDatasourceWrapper: DataSourceWrapper

context: KosmosUserContext<object>

Returns Promise<void>

`Protected` `Optional` _config

`Protected` `Readonly` _dataSourceWrapper

`Protected` _global

`Protected` `Readonly` _graphqlSchemaManager

`Protected` _runtimeConfig

`Protected` `Readonly` _schemaManager

`Protected` `Optional` _type

`Protected` db

`Protected` checkIfAliasExists

`Protected` createAlias

`Protected` deleteByUUID

`Protected` getByUUID

`Protected` isValidPath

`Private` retrieveAlias

`Rest` ...__namedParameters: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]