ldap-rest 1.2.1 → 1.3.0

package/dist/src/plugins/scim/scim.d.ts

@@ -2,7 +2,7 @@ import type { Express, RequestHandler } from 'express';
 import DmPlugin, { type Role } from '../../abstract/plugin';
 import type { DM } from '../../bin';
 import type ldapActions from '../../lib/ldapActions';
-import type { Config } from '../../config/args';
+import { type ScimOptions } from './scim.options';
 import { writeScimErrorFromException } from './errors';
 /**
  * Reusable SCIM 2.0 schemas surfaced by this plugin.
@@ -398,11 +398,44 @@ import { writeScimErrorFromException } from './errors';
  * that a SCIM request sent as such gets the SCIM limit rather than the global
  * parser's 100kb
  *
- * @param config the configuration holding the SCIM limit
+ * @param options the SCIM options holding the payload limit
  * @returns the parser
  */
-export declare function scimBodyParser(config: Config): RequestHandler;
+export declare function scimBodyParser(options: ScimOptions): RequestHandler;
+export declare const ScimIdParams: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+}>;
+export declare const ScimNameParams: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TString;
+}>;
 export default class Scim extends DmPlugin {
+    static optionDefinitions: {
+        scim_prefix: import("../../config/options").StringOption;
+        scim_user_base: import("../../config/options").StringOption;
+        scim_group_base: import("../../config/options").StringOption;
+        scim_user_base_template: import("../../config/options").StringOption;
+        scim_group_base_template: import("../../config/options").StringOption;
+        scim_base_map: import("../../config/options").StringOption;
+        scim_user_base_header: import("../../config/options").StringOption;
+        scim_group_base_header: import("../../config/options").StringOption;
+        scim_base_header_root: import("../../config/options").StringOption;
+        scim_user_object_class: import("../../config/options").ArrayOption;
+        scim_user_rdn_attribute: import("../../config/options").StringOption;
+        scim_user_lock_attribute: import("../../config/options").StringOption;
+        scim_user_lock_value: import("../../config/options").StringOption;
+        scim_group_object_class: import("../../config/options").ArrayOption;
+        scim_group_rdn_attribute: import("../../config/options").StringOption;
+        scim_group_external_id_attribute: import("../../config/options").StringOption;
+        scim_id_attribute: import("../../config/options").StringOption;
+        scim_user_mapping: import("../../config/options").StringOption;
+        scim_group_mapping: import("../../config/options").StringOption;
+        scim_max_results: import("../../config/options").NumberOption;
+        scim_max_scanned: import("../../config/options").NumberOption;
+        scim_bulk_max_operations: import("../../config/options").NumberOption;
+        scim_bulk_max_payload_size: import("../../config/options").NumberOption;
+        scim_etag: import("../../config/options").BooleanOption;
+        scim_base_url: import("../../config/options").StringOption;
+    };
     name: string;
     roles: Role[];
     ldap: ldapActions;
@@ -414,6 +447,7 @@ export default class Scim extends DmPlugin {
     /** Where it reads its schema files, which the static plugins may serve */
     private readonly scimSchemaDir;
     private readonly baseResolver;
+    private readonly settings;
     constructor(server: DM);
     private scimJson;
     /**

package/dist/src/plugins/scim/scim.options.d.ts

@@ -0,0 +1,35 @@
+/**
+ * SCIM 2.0 plugin options, see `docs/plugin-development/options.md`.
+ */
+import type { Config } from '../../config/args';
+import { type OptionsOf } from '../../config/options';
+export declare const scimOptions: {
+    scim_prefix: import("../../config/options").StringOption;
+    scim_user_base: import("../../config/options").StringOption;
+    scim_group_base: import("../../config/options").StringOption;
+    scim_user_base_template: import("../../config/options").StringOption;
+    scim_group_base_template: import("../../config/options").StringOption;
+    scim_base_map: import("../../config/options").StringOption;
+    scim_user_base_header: import("../../config/options").StringOption;
+    scim_group_base_header: import("../../config/options").StringOption;
+    scim_base_header_root: import("../../config/options").StringOption;
+    scim_user_object_class: import("../../config/options").ArrayOption;
+    scim_user_rdn_attribute: import("../../config/options").StringOption;
+    scim_user_lock_attribute: import("../../config/options").StringOption;
+    scim_user_lock_value: import("../../config/options").StringOption;
+    scim_group_object_class: import("../../config/options").ArrayOption;
+    scim_group_rdn_attribute: import("../../config/options").StringOption;
+    scim_group_external_id_attribute: import("../../config/options").StringOption;
+    scim_id_attribute: import("../../config/options").StringOption;
+    scim_user_mapping: import("../../config/options").StringOption;
+    scim_group_mapping: import("../../config/options").StringOption;
+    scim_max_results: import("../../config/options").NumberOption;
+    scim_max_scanned: import("../../config/options").NumberOption;
+    scim_bulk_max_operations: import("../../config/options").NumberOption;
+    scim_bulk_max_payload_size: import("../../config/options").NumberOption;
+    scim_etag: import("../../config/options").BooleanOption;
+    scim_base_url: import("../../config/options").StringOption;
+};
+export type ScimOptions = OptionsOf<typeof scimOptions>;
+/** The checked values for a caller outside the plugin that holds a Config */
+export declare function scimOptionsOf(config: Config): ScimOptions;

package/dist/src/plugins/scim/users.d.ts

@@ -6,9 +6,10 @@
  */
 import type winston from 'winston';
 import type ldapActions from '../../lib/ldapActions';
-import type { Config } from '../../config/args';
 import type { DmRequest } from '../../lib/auth/base';
+import type HookBus from '../../lib/hookBus';
 import { BaseResolver } from './baseResolver';
+import type { ScimOptions } from './scim.options';
 import { type ResourceMapping, type ScimUser, type ListResponse, type PatchRequest } from './types';
 export interface ListQuery {
     filter?: string;
@@ -21,19 +22,17 @@ export interface ListQuery {
 }
 export interface ScimUsersOptions {
     ldap: ldapActions;
-    config: Config;
+    options: ScimOptions;
     logger: winston.Logger;
     baseResolver: BaseResolver;
-    hooks: {
-        [K: string]: Function[] | undefined;
-    };
+    hookBus: HookBus;
 }
 export declare class ScimUsers {
     private readonly ldap;
-    private readonly config;
+    private readonly options;
     private readonly logger;
     private readonly baseResolver;
-    private readonly hooks;
+    private readonly hookBus;
     private readonly mapping;
     private readonly rdnAttribute;
     private readonly objectClass;

package/dist/src/plugins/static.d.ts

@@ -1,5 +1,6 @@
 import type { Express } from 'express';
 import DmPlugin, { type Role } from '../abstract/plugin';
+import type { DM } from '../bin';
 /**
  * @openapi-component
  * LdapSchema:
@@ -35,10 +36,18 @@ import DmPlugin, { type Role } from '../abstract/plugin';
  *         required: true
  */
 export default class Static extends DmPlugin {
+    static optionDefinitions: {
+        static_path: import("../config/options").StringOption;
+        static_name: import("../config/options").StringOption;
+        static_csp: import("../config/options").StringOrFalseOption;
+        static_frame_options: import("../config/options").StringOrFalseOption;
+    };
     name: string;
     roles: Role[];
     /** The configuration's schema files it serves outside its directory, by URL */
     private configured;
+    private readonly settings;
+    constructor(server: DM);
     api(app: Express): void;
     /**
      * The handler of the schema routes

package/dist/src/plugins/static.options.d.ts

@@ -0,0 +1,13 @@
+import type { Config } from '../config/args';
+import { type OptionsOf } from '../config/options';
+/** The headers `core/static` sends unless told otherwise: no framing by another site */
+export declare const STATIC_CSP = "frame-ancestors 'self'";
+export declare const STATIC_FRAME_OPTIONS = "SAMEORIGIN";
+export declare const staticOptions: {
+    static_path: import("../config/options").StringOption;
+    static_name: import("../config/options").StringOption;
+    static_csp: import("../config/options").StringOrFalseOption;
+    static_frame_options: import("../config/options").StringOrFalseOption;
+};
+export type StaticOptions = OptionsOf<typeof staticOptions>;
+export declare function staticOptionsOf(config: Config): StaticOptions;

package/dist/src/plugins/storage.d.ts

@@ -29,9 +29,20 @@
  */
 import DmPlugin from '../abstract/plugin';
 import type { DM } from '../bin';
-import type Store from '../lib/storage/store';
 import type { HealthStatus } from '../lib/health';
+import type Store from '../lib/storage/store';
 export default class Storage extends DmPlugin {
+    static optionDefinitions: {
+        storage_backend: import("../config/options").StringOption;
+        storage_sweep_interval: import("../config/options").NumberOption;
+        storage_ldap_base: import("../config/options").StringOption;
+        storage_ldap_object_class: import("../config/options").StringOption;
+        storage_file_directory: import("../config/options").StringOption;
+        storage_postgres_url: import("../config/options").StringOption;
+        storage_postgres_table: import("../config/options").StringOption;
+        storage_valkey_url: import("../config/options").StringOption;
+        storage_valkey_prefix: import("../config/options").StringOption;
+    };
     name: string;
     store: Store;
     constructor(server: DM);

package/dist/src/plugins/storage.options.d.ts

@@ -0,0 +1,16 @@
+/** Keyed storage plugin options. */
+import type { Config } from '../config/args';
+import { type OptionsOf } from '../config/options';
+export declare const storageOptions: {
+    storage_backend: import("../config/options").StringOption;
+    storage_sweep_interval: import("../config/options").NumberOption;
+    storage_ldap_base: import("../config/options").StringOption;
+    storage_ldap_object_class: import("../config/options").StringOption;
+    storage_file_directory: import("../config/options").StringOption;
+    storage_postgres_url: import("../config/options").StringOption;
+    storage_postgres_table: import("../config/options").StringOption;
+    storage_valkey_url: import("../config/options").StringOption;
+    storage_valkey_prefix: import("../config/options").StringOption;
+};
+export type StorageOptions = OptionsOf<typeof storageOptions>;
+export declare function storageOptionsOf(config: Config): StorageOptions;

package/dist/src/plugins/twake/appAccounts.options.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Applicative accounts options, shared by `appAccountsApi` and
+ * `appAccountsConsistency`. See `docs/plugin-development/options.md`.
+ */
+import { type OptionsOf } from '../../config/options';
+export declare const appAccountsOptions: {
+    applicative_account_base: import("../../config/options").StringOption;
+    max_app_accounts: import("../../config/options").NumberOption;
+    app_accounts_user_attribute: import("../../config/options").StringOption;
+    applicative_account_attribute: import("../../config/options").ArrayOption;
+    ldap_operational_attribute: import("../../config/options").ArrayOption;
+};
+export type AppAccountsOptions = OptionsOf<typeof appAccountsOptions>;

package/dist/src/plugins/twake/appAccountsApi.d.ts

@@ -1,12 +1,30 @@
 import type { Express } from 'express';
 import DmPlugin, { type Role } from '../../abstract/plugin';
 import type { DM } from '../../bin';
+export declare const AppAccountsParams: import("@sinclair/typebox").TObject<{
+    user: import("@sinclair/typebox").TString;
+}>;
+export declare const AppAccountParams: import("@sinclair/typebox").TObject<{
+    user: import("@sinclair/typebox").TString;
+    uid: import("@sinclair/typebox").TString;
+}>;
+export declare const AppAccountCreateBody: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
 export default class AppAccountsApi extends DmPlugin {
+    static optionDefinitions: {
+        applicative_account_base: import("../../config/options").StringOption;
+        max_app_accounts: import("../../config/options").NumberOption;
+        app_accounts_user_attribute: import("../../config/options").StringOption;
+        applicative_account_attribute: import("../../config/options").ArrayOption;
+        ldap_operational_attribute: import("../../config/options").ArrayOption;
+    };
     name: string;
     roles: Role[];
     dependencies: {
         appAccountsConsistency: string;
     };
+    private readonly settings;
     private applicativeAccountBase;
     private maxAppAccounts;
     private mailAttr;

package/dist/src/plugins/twake/appAccountsConsistency.d.ts

@@ -29,11 +29,19 @@ import type { Role } from '../../abstract/plugin';
 import type { DM } from '../../bin';
 import { Hooks } from '../../hooks';
 export default class AppAccountsConsistency extends DmPlugin {
+    static optionDefinitions: {
+        applicative_account_base: import("../../config/options").StringOption;
+        max_app_accounts: import("../../config/options").NumberOption;
+        app_accounts_user_attribute: import("../../config/options").StringOption;
+        applicative_account_attribute: import("../../config/options").ArrayOption;
+        ldap_operational_attribute: import("../../config/options").ArrayOption;
+    };
     name: string;
     roles: Role[];
     dependencies: {
         onLdapChange: string;
     };
+    private readonly settings;
     private mailAttr;
     private applicativeAccountBase;
     private operationalAttributes;

package/dist/src/plugins/twake/calendar.d.ts

@@ -1,6 +1,7 @@
 import TwakePlugin from '../../abstract/twakePlugin';
 import { type Role } from '../../abstract/plugin';
-import { Hooks } from '../../hooks';
+import type { AttributesList, ModifyRequest } from '../../lib/ldapActions';
+import { Hooks, MaybePromise } from '../../hooks';
 /**
  * Plugin to sync LDAP resources and users with Twake Calendar
  *
@@ -10,7 +11,28 @@ import { Hooks } from '../../hooks';
  * Also propagates user identity changes (email, first name, last name) to the
  * Twake Calendar "registered users" via the WebAdmin API.
  */
+/**
+ * The hooks of the `calendarResource` flat entity, which no flag of the
+ * core names: `ldapcalendarResourceadddone`, `…modifydone` and
+ * `…deletedone`.
+ */
+type CalendarResourceHooks = {
+    ldapcalendarResourceadddone?: (dn: string, entry: AttributesList) => MaybePromise<void>;
+    ldapcalendarResourcemodifydone?: (dn: string, changes: ModifyRequest, op: number) => MaybePromise<void>;
+    ldapcalendarResourcedeletedone?: (dn: string) => MaybePromise<void>;
+};
 export default class Calendar extends TwakePlugin {
+    static optionDefinitions: {
+        calendar_webadmin_url: import("../../config/options").StringOption;
+        calendar_webadmin_token: import("../../config/options").StringOption;
+        calendar_concurrency: import("../../config/options").NumberOption;
+        calendar_resource_base: import("../../config/options").StringOption;
+        calendar_resource_objectclass: import("../../config/options").StringOption;
+        calendar_resource_creator: import("../../config/options").StringOption;
+        calendar_resource_domain: import("../../config/options").StringOption;
+        calendar_firstname_attribute: import("../../config/options").StringOption;
+        calendar_lastname_attribute: import("../../config/options").StringOption;
+    };
     name: string;
     roles: Role[];
     dependencies: {
@@ -23,7 +45,7 @@ export default class Calendar extends TwakePlugin {
     private firstnameAttr;
     private lastnameAttr;
     constructor(server: import('../../bin').DM);
-    hooks: Hooks;
+    hooks: Hooks & CalendarResourceHooks;
     /**
      * Check if a LDAP entry is a calendar resource
      */
@@ -111,3 +133,4 @@ export default class Calendar extends TwakePlugin {
         taskId: string;
     } | null>;
 }
+export {};

package/dist/src/plugins/twake/calendar.options.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Twake Calendar plugin options, see `docs/plugin-development/options.md`.
+ */
+import type { Config } from '../../config/args';
+import { type OptionsOf } from '../../config/options';
+export declare const calendarOptions: {
+    calendar_webadmin_url: import("../../config/options").StringOption;
+    calendar_webadmin_token: import("../../config/options").StringOption;
+    calendar_concurrency: import("../../config/options").NumberOption;
+    calendar_resource_base: import("../../config/options").StringOption;
+    calendar_resource_objectclass: import("../../config/options").StringOption;
+    calendar_resource_creator: import("../../config/options").StringOption;
+    calendar_resource_domain: import("../../config/options").StringOption;
+    calendar_firstname_attribute: import("../../config/options").StringOption;
+    calendar_lastname_attribute: import("../../config/options").StringOption;
+};
+export type CalendarOptions = OptionsOf<typeof calendarOptions>;
+/** The checked values for a caller that holds a Config instead of the plugin */
+export declare function calendarOptionsOf(config: Config): CalendarOptions;

package/dist/src/plugins/twake/cloudery.options.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Cloudery provisioning options, see `docs/plugin-development/options.md`.
+ */
+import type { Config } from '../../config/args';
+import { type OptionsOf } from '../../config/options';
+export declare const clouderyOptions: {
+    cloudery_manager_url: import("../../config/options").StringOption;
+    cloudery_manager_token: import("../../config/options").StringOption;
+    cloudery_offer: import("../../config/options").StringOption;
+    cloudery_domain: import("../../config/options").StringOption;
+    cloudery_user_branch: import("../../config/options").StringOption;
+    cloudery_org_id_header: import("../../config/options").StringOption;
+    cloudery_org_role_header: import("../../config/options").StringOption;
+    cloudery_default_org_role: import("../../config/options").StringOption;
+    cloudery_fqdn_attribute: import("../../config/options").StringOption;
+    cloudery_org_id_attribute: import("../../config/options").StringOption;
+    cloudery_org_role_attribute: import("../../config/options").StringOption;
+    cloudery_phones_attribute: import("../../config/options").StringOption;
+    cloudery_invited_attribute: import("../../config/options").StringOption;
+    cloudery_default_locale: import("../../config/options").StringOption;
+    cloudery_workflow_poll_interval_ms: import("../../config/options").NumberOption;
+    cloudery_workflow_max_attempts: import("../../config/options").NumberOption;
+};
+export type ClouderyOptions = OptionsOf<typeof clouderyOptions>;
+/** The checked values for a caller that holds a Config instead of the plugin */
+export declare function clouderyOptionsOf(config: Config): ClouderyOptions;

package/dist/src/plugins/twake/clouderyProvision.d.ts

@@ -2,6 +2,24 @@ import DmPlugin, { type Role } from '../../abstract/plugin';
 import type { DM } from '../../bin';
 import { Hooks } from '../../hooks';
 export default class ClouderyProvision extends DmPlugin {
+    static optionDefinitions: {
+        cloudery_manager_url: import("../../config/options").StringOption;
+        cloudery_manager_token: import("../../config/options").StringOption;
+        cloudery_offer: import("../../config/options").StringOption;
+        cloudery_domain: import("../../config/options").StringOption;
+        cloudery_user_branch: import("../../config/options").StringOption;
+        cloudery_org_id_header: import("../../config/options").StringOption;
+        cloudery_org_role_header: import("../../config/options").StringOption;
+        cloudery_default_org_role: import("../../config/options").StringOption;
+        cloudery_fqdn_attribute: import("../../config/options").StringOption;
+        cloudery_org_id_attribute: import("../../config/options").StringOption;
+        cloudery_org_role_attribute: import("../../config/options").StringOption;
+        cloudery_phones_attribute: import("../../config/options").StringOption;
+        cloudery_invited_attribute: import("../../config/options").StringOption;
+        cloudery_default_locale: import("../../config/options").StringOption;
+        cloudery_workflow_poll_interval_ms: import("../../config/options").NumberOption;
+        cloudery_workflow_max_attempts: import("../../config/options").NumberOption;
+    };
     name: string;
     roles: Role[];
     dependencies: {

package/dist/src/plugins/twake/cozy.options.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Cozy provisioning options, shared by `cozyProvision` and
+ * `clouderyProvision`. See `docs/plugin-development/options.md`.
+ */
+import type { Config } from '../../config/args';
+import { type OptionsOf } from '../../config/options';
+export declare const cozyOptions: {
+    cozy_admin_url: import("../../config/options").StringOption;
+    cozy_admin_user: import("../../config/options").StringOption;
+    cozy_admin_passphrase: import("../../config/options").StringOption;
+    cozy_org_id: import("../../config/options").StringOption;
+    cozy_org_domain: import("../../config/options").StringOption;
+    cozy_default_locale: import("../../config/options").StringOption;
+    cozy_context_name: import("../../config/options").StringOption;
+    cozy_apps: import("../../config/options").StringOption;
+    cozy_auth_exchange: import("../../config/options").StringOption;
+    cozy_b2b_exchange: import("../../config/options").StringOption;
+    cozy_user_created_routing_key: import("../../config/options").StringOption;
+    cozy_user_deleted_routing_key: import("../../config/options").StringOption;
+};
+export type CozyOptions = OptionsOf<typeof cozyOptions>;
+/** The checked values for a caller that holds a Config instead of the plugin */
+export declare function cozyOptionsOf(config: Config): CozyOptions;

package/dist/src/plugins/twake/cozyProvision.d.ts

@@ -2,6 +2,20 @@ import DmPlugin, { type Role } from '../../abstract/plugin';
 import type { DM } from '../../bin';
 import { Hooks } from '../../hooks';
 export default class CozyProvision extends DmPlugin {
+    static optionDefinitions: {
+        cozy_admin_url: import("../../config/options").StringOption;
+        cozy_admin_user: import("../../config/options").StringOption;
+        cozy_admin_passphrase: import("../../config/options").StringOption;
+        cozy_org_id: import("../../config/options").StringOption;
+        cozy_org_domain: import("../../config/options").StringOption;
+        cozy_default_locale: import("../../config/options").StringOption;
+        cozy_context_name: import("../../config/options").StringOption;
+        cozy_apps: import("../../config/options").StringOption;
+        cozy_auth_exchange: import("../../config/options").StringOption;
+        cozy_b2b_exchange: import("../../config/options").StringOption;
+        cozy_user_created_routing_key: import("../../config/options").StringOption;
+        cozy_user_deleted_routing_key: import("../../config/options").StringOption;
+    };
     name: string;
     roles: Role[];
     dependencies: {

package/dist/src/plugins/twake/drive.d.ts

@@ -11,6 +11,13 @@ import { type Role } from '../../abstract/plugin';
 import type { DM } from '../../bin';
 import { Hooks } from '../../hooks';
 export default class Drive extends TwakePlugin {
+    static optionDefinitions: {
+        twake_drive_webadmin_url: import("../../config/options").StringOption;
+        twake_drive_webadmin_token: import("../../config/options").StringOption;
+        twake_drive_concurrency: import("../../config/options").NumberOption;
+        twake_drive_domain_attribute: import("../../config/options").StringOption;
+        twake_drive_default_domain_template: import("../../config/options").StringOption;
+    };
     name: string;
     roles: Role[];
     dependencies: {

package/dist/src/plugins/twake/drive.options.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Twake Drive plugin options, see `docs/plugin-development/options.md`.
+ */
+import type { Config } from '../../config/args';
+import { type OptionsOf } from '../../config/options';
+export declare const driveOptions: {
+    twake_drive_webadmin_url: import("../../config/options").StringOption;
+    twake_drive_webadmin_token: import("../../config/options").StringOption;
+    twake_drive_concurrency: import("../../config/options").NumberOption;
+    twake_drive_domain_attribute: import("../../config/options").StringOption;
+    twake_drive_default_domain_template: import("../../config/options").StringOption;
+};
+export type DriveOptions = OptionsOf<typeof driveOptions>;
+/** The checked values for a caller that holds a Config instead of the plugin */
+export declare function driveOptionsOf(config: Config): DriveOptions;

package/dist/src/plugins/twake/groups.d.ts

@@ -39,7 +39,11 @@ export declare function dnKey(dn: string): string;
 export declare function parentOf(dn: string): string;
 /**
  * The entries one level under a DN pattern holding `{org}`, the organization
- * captured as one RDN value: `(?:\\.|[^,])+` keeps an escaped comma inside it.
+ * captured as one RDN value: an escaped comma stays inside it.
+ *
+ * A backslash and the character it escapes are read as one, and a comma ends
+ * the value, so each character of the value is followed one way whatever
+ * the DN holds.
  */
 export declare function branchPattern(base: string): RegExp;
 /**
@@ -49,7 +53,31 @@ export declare function branchPattern(base: string): RegExp;
 export declare function movedInto(pattern: RegExp, dn: string, newDn: string): string | undefined;
 /** The organization of an entry one level under a branch pattern. */
 export declare function organizationIn(pattern: RegExp, dn: string): string | undefined;
+export declare const TwakeOrganizationParams: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+}>;
+export declare const OrganizationGroupParams: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    groupId: import("@sinclair/typebox").TString;
+}>;
+export declare const OrganizationGroupMemberParams: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    groupId: import("@sinclair/typebox").TString;
+    userId: import("@sinclair/typebox").TString;
+}>;
 export default class TwakeGroups extends LdapGroups {
+    static optionDefinitions: {
+        twake_group_base: import("../../config/options").StringOption;
+        twake_group_user_base: import("../../config/options").StringOption;
+        twake_group_organization_dn: import("../../config/options").StringOption;
+        twake_group_organization_status_attribute: import("../../config/options").StringOption;
+        twake_group_organization_deleted_value: import("../../config/options").StringOption;
+        twake_group_display_name_attribute: import("../../config/options").StringOption;
+        twake_group_color_attribute: import("../../config/options").StringOption;
+        twake_group_created_at_attribute: import("../../config/options").StringOption;
+        twake_group_max_page_limit: import("../../config/options").NumberOption;
+        twake_group_member_fields: import("../../config/options").JsonOption<{}>;
+    };
     name: string;
     protected readonly groupBase: string;
     protected readonly userBase: string;

package/dist/src/plugins/twake/instances.d.ts

@@ -1,13 +1,3 @@
-/**
- * @module plugins/twake/instances
- *
- * Gives every account this server creates its workplace instance, once its
- * entry is written, from the Cloudery or from the cozy-stack admin API. The
- * address is written once the instance exists, then `user.created` is
- * published and the entry marked. The event is sent at least once.
- *
- * See `docs/usage/plugins/integrations/instances.md`.
- */
 import type { Express, Request } from 'express';
 import DmPlugin, { type Role } from '../../abstract/plugin';
 import type { DM } from '../../bin';
@@ -23,12 +13,55 @@ export interface WorkplaceCreated {
 interface Account extends InstanceRequest {
     twakeId: string;
 }
+export declare const EnsureInstanceBody: import("@sinclair/typebox").TObject<{
+    dn: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    mail: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const EnsureInstanceResponse: import("@sinclair/typebox").TObject<{
+    state: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"ready">, import("@sinclair/typebox").TLiteral<"pending">]>;
+}>;
 export default class TwakeInstances extends DmPlugin {
+    static optionDefinitions: {
+        twake_instance_dn: import("../../config/options").ArrayOption;
+        twake_instance_skip_attribute: import("../../config/options").StringOption;
+        twake_instance_skip_value: import("../../config/options").StringOption;
+        twake_instance_provider: import("../../config/options").StringOption;
+        twake_instance_id: import("../../config/options").StringOption;
+        twake_instance_fqdn_attribute: import("../../config/options").StringOption;
+        twake_instance_sent_attribute: import("../../config/options").StringOption;
+        twake_instance_locale: import("../../config/options").StringOption;
+        twake_instance_timeout: import("../../config/options").NumberOption;
+        twake_instance_cloudery_url: import("../../config/options").StringOption;
+        twake_instance_cloudery_token: import("../../config/options").StringOption;
+        twake_instance_cloudery_offer: import("../../config/options").StringOption;
+        twake_instance_cloudery_domain: import("../../config/options").StringOption;
+        twake_instance_cloudery_organization_offer: import("../../config/options").StringOption;
+        twake_instance_cozy_url: import("../../config/options").StringOption;
+        twake_instance_cozy_user: import("../../config/options").StringOption;
+        twake_instance_cozy_passphrase: import("../../config/options").StringOption;
+        twake_instance_cozy_domain: import("../../config/options").StringOption;
+        twake_instance_cozy_context: import("../../config/options").StringOption;
+        twake_instance_cozy_apps: import("../../config/options").StringOption;
+        twake_instance_cozy_org_id: import("../../config/options").StringOption;
+        twake_instance_cozy_org_domain: import("../../config/options").StringOption;
+        twake_instance_auth_exchange: import("../../config/options").StringOption;
+        twake_instance_b2b_exchange: import("../../config/options").StringOption;
+        twake_instance_user_created_key: import("../../config/options").StringOption;
+        twake_instance_organization_created_key: import("../../config/options").StringOption;
+        twake_instance_workplace_created_key: import("../../config/options").StringOption;
+        twake_instance_queue: import("../../config/options").StringOption;
+        twake_instance_organization_base: import("../../config/options").StringOption;
+        twake_instance_organization_id_attribute: import("../../config/options").StringOption;
+        twake_instance_organization_domain_attribute: import("../../config/options").StringOption;
+        twake_instance_organization_name_attribute: import("../../config/options").StringOption;
+        twake_instance_organization_fqdn_attribute: import("../../config/options").StringOption;
+    };
     name: string;
     roles: Role[];
     dependencies: {
         rabbitmq: string;
     };
+    private readonly settings;
     protected readonly patterns: RegExp[];
     protected readonly provider: InstanceProvider;
     protected readonly fqdnAttribute: string;