@edifice.io/client 2.1.0-develop-enabling.0 → 2.1.0-develop-b2school.20250204153130

package/dist/notify/Framework.d.ts

@@ -0,0 +1,29 @@
+import { IGetConf, ITheme, IThemeOverrides } from '../configure/interfaces';
+import { IUserInfo } from '../session/interfaces';
+import { Subject } from './Subject';
+import { IPromisified, INotifyFramework } from './interfaces';
+/** Utility class */
+export declare class Promisified<T> implements IPromisified<T> {
+    private _resolution?;
+    private _rejection?;
+    private _promise;
+    get promise(): Promise<T>;
+    resolve(value: T | PromiseLike<T>): void;
+    reject(reason?: any): void;
+}
+/** The notify framework implementation. */
+declare class NotifyFramework implements INotifyFramework {
+    private promises;
+    private subject;
+    private asyncData;
+    onSessionReady(): IPromisified<IUserInfo>;
+    onLangReady(): IPromisified<string>;
+    onSkinReady(): Promisified<ITheme>;
+    onOverridesReady(): Promisified<IThemeOverrides>;
+    onAppConfReady(): Promisified<IGetConf>;
+    promisify<T>(): IPromisified<T>;
+    events(): Subject;
+}
+/** The whole framework is a singleton. */
+export declare const notify: NotifyFramework;
+export {};

package/dist/notify/Subject.d.ts

@@ -0,0 +1,9 @@
+import { IHttpErrorEvent, ISubject, ISubjectMessage, ISubscription, LayerName } from './interfaces';
+export declare class Subject implements ISubject {
+    private publishChannels;
+    private getChannelName;
+    private getPublishChannel;
+    newChannel(layer: string): BroadcastChannel;
+    publish(layer: LayerName, message: ISubjectMessage | IHttpErrorEvent): void;
+    subscribe<T extends ISubjectMessage>(layer: LayerName, handler: (message: T) => void): ISubscription;
+}

package/dist/notify/interfaces.d.ts

@@ -1,6 +1,9 @@
 import { IGetConf, ITheme, IThemeOverrides } from '../configure/interfaces';
-import { IHttpParams, IHttpResponse } from '../http/interfaces';
 import { IUserInfo } from '../session/interfaces';
+import { IHttpParams, IHttpResponse } from '../transport/interfaces';
+export declare abstract class NotifyFrameworkFactory {
+    static instance(): INotifyFramework;
+}
 export interface INotifyFramework {
     /**
      * Notify that a process is done and data ready or rejected.

package/dist/resources/ResourceService.d.ts

@@ -20,7 +20,7 @@ export declare abstract class ResourceService implements IResourceService, IWebR
         resourceType: ResourceType | "main";
     }) => boolean;
     constructor(context: IOdeServices);
-    protected get http(): import('../http/Service').HttpService;
+    protected get http(): import('../transport/Service').HttpService;
     abstract getApplication(): App | string;
     abstract getPrintUrl(resourceId: string): string;
     abstract getViewUrl(resourceId: string): string;

package/dist/resources/interface.d.ts

@@ -384,7 +384,15 @@ export interface CollaborativewallUpdate extends UpdateParameters {
 export interface CollaborativewallResource extends IResource {
     'publish-type': 'RESTRAINT' | 'IMMEDIATE';
 }
+export interface HomeworksCreate extends CreateParameters {
+    repeats?: any[];
+}
+export interface HomeworksUpdate extends UpdateParameters {
+    repeats?: any[];
+}
 export interface ScrapbookUpdate extends UpdateParameters {
 }
 export interface ScrapbookResource extends IResource {
 }
+export interface TimelineGeneratorUpdate extends UpdateParameters {
+}

package/dist/resources/services/HomeworksResourceService.d.ts

@@ -0,0 +1,14 @@
+import { ResourceType } from '../..';
+import { HomeworksCreate, CreateResult, HomeworksUpdate, UpdateResult } from '../interface';
+import { ResourceService } from '../ResourceService';
+export declare class HomeworksResourceService extends ResourceService {
+    create<T extends HomeworksCreate>(parameters: T): Promise<CreateResult>;
+    update(parameters: HomeworksUpdate): Promise<UpdateResult>;
+    getResourceType(): ResourceType;
+    getApplication(): string;
+    getFormUrl(folderId?: string): string;
+    getViewUrl(resourceId: string): string;
+    getPrintUrl(resourceId: string): string;
+    getEditUrl(resourceId: string): string;
+    getExportUrl(): string;
+}

package/dist/resources/services/TimelineGeneratorResourceService.d.ts

@@ -0,0 +1,14 @@
+import { ResourceType } from '../..';
+import { CreateParameters, CreateResult, TimelineGeneratorUpdate, UpdateResult } from '../interface';
+import { ResourceService } from '../ResourceService';
+export declare class TimelineGeneratorResourceService extends ResourceService {
+    create(parameters: CreateParameters): Promise<CreateResult>;
+    update(parameters: TimelineGeneratorUpdate): Promise<UpdateResult>;
+    getResourceType(): ResourceType;
+    getApplication(): string;
+    getFormUrl(): string;
+    getViewUrl(resourceId: string): string;
+    getPrintUrl(resourceId: string): string;
+    getEditUrl(): string;
+    getExportUrl(): string;
+}

package/dist/services/OdeServices.d.ts

@@ -1,25 +1,31 @@
-import { AnalyticsService } from '../analytics/Service';
-import { IAudienceService } from '../audience/interface';
 import { CacheService } from '../cache/Service';
 import { ConfService } from '../configure/Service';
 import { DirectoryService } from '../directory/Service';
-import { EmbedderService } from '../embedder/Service';
-import { App, ResourceType } from '../globals';
-import { HttpService } from '../http/Service';
-import { IBehaviourService, IResourceService, IWebResourceService } from '../resources/interface';
+import { HttpService } from '../transport/Service';
 import { RightService } from '../rights/Service';
 import { SessionService } from '../session/Service';
 import { ShareService } from '../share/Service';
-import { VideoService } from '../video/Service';
 import { WorkspaceService } from '../workspace/Service';
-import { AxiosInstance } from 'axios';
+import { IdiomService } from '../idiom/Service';
+import { AnalyticsService } from '../analytics/Service';
+import { IAudienceService } from '../audience/interface';
+import { VideoService } from '../video/Service';
+import { App, ResourceType } from '../globals';
+import { IBehaviourService, IResourceService, IWebResourceService } from '../resources/interface';
+import { EmbedderService } from '../embedder/Service';
+import { INotifyFramework } from '../notify/interfaces';
+import { DataService } from '../data/Service';
+import { IDataService } from '../data/interface';
 export interface IOdeServices {
     analytics(): AnalyticsService;
     audience(application: App, resourceType: ResourceType): IAudienceService;
     cache(): CacheService;
     conf(): ConfService;
+    data(): IDataService;
     directory(): DirectoryService;
     http(): HttpService;
+    idiom(): IdiomService;
+    notify(): INotifyFramework;
     resource(application: App, resourceType?: ResourceType): IResourceService & IWebResourceService;
     behaviour(application: App, resourceType: ResourceType): IBehaviourService;
     rights(): RightService;
@@ -28,36 +34,33 @@ export interface IOdeServices {
     video(): VideoService;
     workspace(): WorkspaceService;
     embedder(): EmbedderService;
-    withAxiosInstance(axiosInstance: AxiosInstance): this;
-    withBaseUrl(baseUrl?: string): this;
-    withHeaders(headers: Record<string, string>): this;
 }
 export declare class OdeServices implements IOdeServices {
     private _analytics;
     private _cache;
     private _conf;
+    private _data;
     private _directory;
     private _http;
+    private _idiom;
+    private _notify;
     private _rights;
     private _session;
     private _share;
     private _video;
     private _workspace;
     private _embedder;
-    private baseUrl?;
-    private headers;
-    private axiosInstance;
     constructor();
     initialize(): OdeServices;
-    withAxiosInstance(axiosInstance: AxiosInstance): this;
-    withHeaders(headers: Record<string, string>): this;
-    withBaseUrl(baseUrl: string): this;
     analytics(): AnalyticsService;
     audience(application: App, resourceType: ResourceType): IAudienceService;
     cache(): CacheService;
     conf(): ConfService;
+    data(): DataService;
     directory(): DirectoryService;
     http(): HttpService;
+    idiom(): IdiomService;
+    notify(): INotifyFramework;
     resource(application: App, resourceType?: ResourceType): IResourceService & IWebResourceService;
     behaviour(application: App, resourceType: ResourceType): IBehaviourService;
     rights(): RightService;

package/dist/session/Framework.d.ts

@@ -0,0 +1,10 @@
+import { ISessionFramework } from './interfaces';
+import { Session } from './Session';
+export declare class SessionFramework implements ISessionFramework {
+    session: Session;
+    initialize(): Promise<void>;
+    login(email: string, password: string, rememberMe?: boolean, secureLocation?: boolean): Promise<void>;
+    logout(): Promise<void>;
+}
+/** The whole framework is a singleton. */
+export declare const session: SessionFramework;

package/dist/session/Service.d.ts

@@ -4,7 +4,7 @@ import { IOdeServices } from '../services/OdeServices';
 export declare class SessionService {
     private context;
     constructor(context: IOdeServices);
-    get http(): import('../http/Service').HttpService;
+    get http(): import('../transport/Service').HttpService;
     get cache(): import('../cache/Service').CacheService;
     private get conf();
     /**

package/dist/session/Session.d.ts

@@ -0,0 +1,34 @@
+import { IEmailValidationInfos, IEmailValidationState, IMfaCodeState, IMfaInfos, IMobileValidationInfos, IMobileValidationState, IQuotaAndUsage, ISession, IUserDescription, IUserInfo, UserProfile } from './interfaces';
+import { App } from '../globals';
+export declare class Session implements ISession {
+    private _me;
+    private _currentLanguage;
+    private _notLoggedIn;
+    private _description?;
+    private _profile?;
+    get currentLanguage(): string;
+    get notLoggedIn(): boolean;
+    get description(): IUserDescription;
+    get avatarUrl(): string;
+    get user(): IUserInfo;
+    get currentApp(): App | null;
+    initialize(): Promise<void>;
+    private setCurrentModel;
+    hasWorkflow(workflowName: string): boolean;
+    hasRight(resource: any, right: any): boolean;
+    get latestQuotaAndUsage(): Promise<IQuotaAndUsage>;
+    private setCurrentLanguage;
+    private loadDefaultLanguage;
+    private loadDescription;
+    get profile(): UserProfile;
+    getUserProfile(): Promise<UserProfile>;
+    private loadUserLanguage;
+    getEmailValidationInfos(): Promise<IEmailValidationInfos>;
+    checkEmail(email: string): Promise<void>;
+    tryEmailValidation(code: string): Promise<IEmailValidationState>;
+    getMobileValidationInfos(): Promise<IMobileValidationInfos>;
+    checkMobile(mobile: string): Promise<void>;
+    tryMobileValidation(code: string): Promise<IMobileValidationState>;
+    getMfaInfos(): Promise<IMfaInfos>;
+    tryMfaCode(code: string): Promise<IMfaCodeState>;
+}

package/dist/session/interfaces.d.ts

@@ -1,5 +1,8 @@
 import { App } from '../globals';
 import { WidgetName } from '../widget/interfaces';
+export declare abstract class SessionFrameworkFactory {
+    static instance(): ISessionFramework;
+}
 export interface ISessionFramework {
     /** Initialize once before use. */
     initialize(): Promise<void>;
@@ -50,22 +53,22 @@ export interface ISession {
      * Send a 6-digits code to an email address to validate it.
      * => when resolved successfully, the email validation infos will switch to the "pending" state.
      */
-    checkEmail(email: String): Promise<void>;
+    checkEmail(email: string): Promise<void>;
     /** Send a 6-digits code to the server to try validating the pending email address. */
-    tryEmailValidation(code: String): Promise<IEmailValidationState>;
+    tryEmailValidation(code: string): Promise<IEmailValidationState>;
     /** Verify if the logged-in user has a valid phone number. */
     getMobileValidationInfos(): Promise<IMobileValidationInfos>;
     /**
      * Send a 6-digits code to a phone number to validate it.
      * => when resolved successfully, the phone number infos will switch to the "pending" state.
      */
-    checkMobile(mobile: String): Promise<void>;
+    checkMobile(mobile: string): Promise<void>;
     /** Send a 6-digits code to the server to try validating the pending phone number. */
-    tryMobileValidation(code: String): Promise<IMobileValidationState>;
+    tryMobileValidation(code: string): Promise<IMobileValidationState>;
     /** Start an MFA for the logged-in user, unless already pending or done. */
     getMfaInfos(): Promise<IMfaInfos>;
     /** Send a 6-digits code to the server to validate a pending MFA. */
-    tryMfaCode(code: String): Promise<IMfaCodeState>;
+    tryMfaCode(code: string): Promise<IMfaCodeState>;
 }
 export type Hobby = {
     visibility: 'PRIVE' | 'PUBLIC';

package/dist/share/Service.d.ts

@@ -4,7 +4,7 @@ export declare class ShareService {
     protected context: IOdeServices;
     constructor(context: IOdeServices);
     get directory(): import('../directory/Service').DirectoryService;
-    get http(): import('../http/Service').HttpService;
+    get http(): import('../transport/Service').HttpService;
     get cache(): import('../cache/Service').CacheService;
     searchShareSubjects(app: string, resourceId: string, searchText: string): Promise<ShareSubject[]>;
     getShareMapping(app: string): Promise<ShareMapping>;

package/dist/transport/Framework.d.ts

@@ -0,0 +1,9 @@
+import { IHttp, ITransportFramework } from './interfaces';
+declare class TransportFramework implements ITransportFramework {
+    private _http;
+    get http(): IHttp;
+    newHttpInstance(params?: any): IHttp;
+}
+/** The whole framework is a singleton. */
+export declare const transport: TransportFramework;
+export {};

package/dist/transport/Http.d.ts

@@ -0,0 +1,26 @@
+import { IHttp, IHttpParams, IHttpResponse } from './interfaces';
+export declare class Http implements IHttp {
+    private axios;
+    private _latestResponse;
+    constructor(params?: any);
+    setCdn(cdnUrl: string): void;
+    private toAxiosConfig;
+    private toCdnUrl;
+    private mapAxiosError;
+    private mapAxiosResponse;
+    get latestResponse(): IHttpResponse;
+    isResponseError(): boolean;
+    get<R = any>(url: string, params?: IHttpParams): Promise<R>;
+    post<R = any>(url: string, data?: any, params?: IHttpParams): Promise<R>;
+    postFile<R = any>(url: string, data: any, params?: IHttpParams): Promise<R>;
+    postJson<R = any>(url: string, json: any, params?: IHttpParams): Promise<R>;
+    put<R = any>(url: string, data?: any, params?: IHttpParams): Promise<R>;
+    putJson<R = any>(url: string, json: any, params?: IHttpParams): Promise<R>;
+    delete<R = any>(url: string, params?: IHttpParams): Promise<R>;
+    deleteJson<R = any>(url: string, json: any): Promise<R>;
+    getScript<R = any>(url: string, params?: IHttpParams, variableName?: string): Promise<R>;
+    loadScript(url: string, params?: IHttpParams): Promise<void>;
+}
+/**
+ * Promisified HTTP
+ */

package/dist/{http → transport}/Service.d.ts

@@ -1,4 +1,3 @@
-import { AxiosInstance } from 'axios';
 import { IOdeServices } from '../services/OdeServices';
 import { IHttp, IHttpParams, IHttpResponse } from './interfaces';
 export declare class HttpService implements IHttp {
@@ -7,9 +6,8 @@ export declare class HttpService implements IHttp {
     private baseUrl?;
     private headers;
     private _latestResponse;
-    constructor(context: IOdeServices);
+    constructor(context: IOdeServices, params?: any);
     private fixBaseUrl;
-    useAxiosInstance(axiosInstance: AxiosInstance): this;
     useBaseUrl(baseUrl?: string): this;
     useHeaders(headers: Record<string, string>): this;
     setCdn(cdnUrl: string): void;

package/dist/{http → transport}/interfaces.d.ts

@@ -1,3 +1,6 @@
+export declare abstract class TransportFrameworkFactory {
+    static instance(): ITransportFramework;
+}
 export interface ITransportFramework {
     /** Default instance. */
     readonly http: IHttp;

package/dist/widget/Framework.d.ts

@@ -0,0 +1,31 @@
+import { IWidgetFramework, IWidget, WidgetUserPref, WidgetName } from './interfaces';
+import { IWidgetModel, WidgetPosition } from '../session/interfaces';
+export declare class WidgetFramework implements IWidgetFramework {
+    private _initialized?;
+    private _widgets;
+    initialize(version: string | null, cdnDomain: string | null): Promise<void>;
+    get list(): Widget[];
+    lookup(widgetName: string): IWidget | undefined;
+    lookupDefaultPosition(widgetName: WidgetName): WidgetPosition | undefined;
+    private _userPrefs;
+    get userPrefs(): IWidgetUserPrefs;
+    private loadUserPrefs;
+    saveUserPrefs(): Promise<void>;
+    private applyUserPrefs;
+}
+declare class Widget implements IWidget {
+    private _platformConf;
+    constructor(_platformConf: IWidgetModel);
+    get platformConf(): IWidgetModel;
+    private _schoolConf;
+    get schoolConf(): {};
+    private _userPref;
+    get userPref(): WidgetUserPref;
+    applyUserPref(pref: WidgetUserPref): void;
+}
+interface IWidgetUserPrefs {
+    [widgetName: string]: WidgetUserPref;
+}
+/** The whole framework is a singleton. */
+export declare const widgets: WidgetFramework;
+export {};

package/dist/widget/LastInfos.widget.d.ts

@@ -1,4 +1,3 @@
-import { IOdeServices } from '../services/OdeServices';
 export interface ILastInfosModel {
     date: string;
     shared: [];
@@ -10,9 +9,6 @@ export interface ILastInfosModel {
     _id: number;
 }
 export declare class LastInfosWidget {
-    protected context: IOdeServices;
-    constructor(context: IOdeServices);
-    get http(): import('../http/Service').HttpService;
     loadInfos(maxResults: number): Promise<ILastInfosModel[]>;
     getMaxResults(): Promise<number>;
     setMaxResults(maxResults: number): Promise<void>;

package/dist/widget/interfaces.d.ts

@@ -20,6 +20,9 @@ export declare const WIDGET_NAME: {
     readonly SCHOOL: "school-widget";
 };
 export type WidgetName = (typeof WIDGET_NAME)[keyof typeof WIDGET_NAME];
+export declare abstract class WidgetFrameworkFactory {
+    static instance(): IWidgetFramework;
+}
 export interface IWidgetFramework {
     /** Loads the widget configuration. */
     initialize(version: string | null, cdnDomain: string | null): Promise<void>;

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "@edifice.io/client",
-  "version": "2.1.0-develop-enabling.0",
+  "version": "2.1.0-develop-b2school.20250204153130",
   "description": "Edifice TypeScript Client",
+  "keywords": [
+    "typescript",
+    "client",
+    "edifice",
+    "frontend"
+  ],
   "homepage": "https://github.com/edificeio/edifice-frontend-framework/tree/main/packages/client#readme",
   "bugs": {
     "url": "https://github.com/edificeio/edifice-frontend-framework/issues"
@@ -30,24 +36,28 @@
   "dependencies": {
     "axios": "^1.7.7",
     "core-js": "^3.35.1",
-    "@edifice.io/utilities": "2.1.0-develop-enabling.0"
+    "@edifice.io/utilities": "2.1.0-develop-b2school.20250204153130"
   },
   "devDependencies": {
     "@types/jasmine": "5.1.4",
-    "@types/node": "catalog:",
+    "@types/node": "^22.9.1",
     "jasmine": "5.1.0",
     "rimraf": "5.0.5",
-    "rollup-plugin-visualizer": "catalog:",
+    "rollup-plugin-visualizer": "5.12.0",
     "typedoc": "0.25.7",
     "typedoc-plugin-markdown": "3.17.1",
-    "vite": "catalog:",
-    "vite-plugin-dts": "catalog:"
+    "vite": "^5.4.11",
+    "vite-plugin-dts": "^4.1.0",
+    "@edifice.io/config": "2.1.0-develop-b2school.20250204153130"
   },
   "scripts": {
     "build": "vite build",
     "docs": "npx rimraf ./docs/ && npx typedoc src/ts/index.ts --excludePrivate --disableSources --plugin typedoc-plugin-markdown",
+    "fix": "eslint --fix --report-unused-disable-directives --max-warnings 0",
     "format": "pnpm run format:write && pnpm run format:check",
     "format:check": "npx prettier --check \"src/ts/**/*.ts\"",
-    "format:write": "npx prettier --write \"src/ts/**/*.ts\""
+    "format:write": "npx prettier --write \"src/ts/**/*.ts\"",
+    "lint": "eslint",
+    "test": "vitest"
   }
 }