This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/web/src
Ken Sternberg a2dce3fb63
web: Replace calls to rootInterface()?.tenant? with a contextual this.tenant object (#7778)
* This commit abstracts access to the object `rootInterface()?.config?` into a single accessor,
`authentikConfig`, that can be mixed into any AKElement object that requires access to it.

Since access to `rootInterface()?.config?` is _universally_ used for a single (and repetitive)
boolean check, a separate accessor has been provided that converts all calls of the form:

``` javascript
rootInterface()?.config?.capabilities.includes(CapabilitiesEnum.CanImpersonate)
```

into:

``` javascript
this.can(CapabilitiesEnum.CanImpersonate)
```

It does this via a Mixin, `WithCapabilitiesConfig`, which understands that these calls only make
sense in the context of a running, fully configured authentik instance, and that their purpose is to
inform authentik components of a user’s capabilities. The latter is why I don’t feel uncomfortable
turning a function call into a method; we should make it explicit that this is a relationship
between components.

The mixin has a single single field, `[WCC.capabilitiesConfig]`, where its association with the
upper-level configuration is made. If that syntax looks peculiar to you, good! I’ve used an explict
unique symbol as the field name; it is inaccessable an innumerable in the object list. The debugger
shows it only as:

    Symbol(): {
        cacheTimeout: 300
        cacheTimeoutFlows: 300
        cacheTimeoutPolicies: 300
        cacheTimeoutReputation: 300
        capabilities: (5) ['can_save_media', 'can_geo_ip', 'can_impersonate', 'can_debug', 'is_enterprise']
    }

Since you can’t reference it by identity, you can’t write to it. Until every browser supports actual
private fields, this is the best we can do; it does guarantee that field name collisions are
impossible, which is a win.

The mixin takes a second optional boolean; setting this to true will cause any web component using
the mixin to automatically schedule a re-render if the capabilities list changes.

The mixin is also generic; despite the "...into a Lit-Context" in the title, the internals of the
Mixin can be replaced with anything so long as the signature of `.can()` is preserved.

Because this work builds off the work I did to give the Sidebar access to the configuration without
ad-hoc retrieval or prop-drilling, it wasn’t necessary to create a new context for it. That will be
necessary for the following:

TODO:

``` javascript
rootInterface()?.uiConfig;
rootInterface()?.tenant;
me();
```

* This commit abstracts access to the object `rootInterface()?.tenant?` into a single accessor,
`tenant`, that can be mixed into any AKElement object that requires access to it.

Like `WithCapabilitiesConfig` and `WithAuthentikConfig`, this one is named `WithTenantConfig`.

TODO:

``` javascript
rootInterface()?.uiConfig;
me();
```

* web: Added a README with a description of the applications' "mental model," essentially an architectural description.

* web: prettier did a thing

* web: prettier had opinions about the README

* web: Jens requested that subscription be  by default, and it's the right call.

* web: Jens requested that the default subscription state for contexts be , and it's the right call.

* web: prettier having opinions after merging with dependent branch

* web: prettier still having opinions.
2024-01-08 13:03:00 -08:00
..
admin web: Replace calls to rootInterface()?.tenant? with a contextual this.tenant object (#7778) 2024-01-08 13:03:00 -08:00
assets/images web/flows: update flow background (#7833) 2023-12-09 14:20:59 +02:00
common release: 2023.10.5 2023-12-21 15:08:13 +01:00
components enterprise/providers: Add RAC [AUTH-15] (#7291) 2023-12-30 21:33:14 +01:00
elements web: Replace calls to rootInterface()?.tenant? with a contextual this.tenant object (#7778) 2024-01-08 13:03:00 -08:00
enterprise/rac web: abstract rootInterface()?.config?.capabilities.includes() into .can() (#7737) 2024-01-08 10:22:52 -08:00
flow web: abstract rootInterface()?.config?.capabilities.includes() into .can() (#7737) 2024-01-08 10:22:52 -08:00
locales web: Replace lingui.js with lit-localize (#5761) 2023-06-02 08:08:36 -07:00
polyfill web: bump @formatjs/intl-listformat from 7.2.2 to 7.3.0 in /web (#5866) 2023-06-08 13:28:15 +02:00
standalone web: abstract rootInterface()?.config?.capabilities.includes() into .can() (#7737) 2024-01-08 10:22:52 -08:00
stories web: abstract rootInterface()?.config?.capabilities.includes() into .can() (#7737) 2024-01-08 10:22:52 -08:00
user web: Replace calls to rootInterface()?.tenant? with a contextual this.tenant object (#7778) 2024-01-08 13:03:00 -08:00
custom.css *: add placeholder custom.css to easily allow user customisation 2022-02-14 20:05:00 +01:00
global.d.ts web: fix turnstile types after update (#7854) 2023-12-13 15:33:47 +01:00
locale-codes.ts web: update some locale details (#8090) 2024-01-08 17:27:09 +00:00