@edifice.io/client 1.7.4-develop-pedago.20241211160712

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

@@ -0,0 +1,15 @@
+export interface ILastInfosModel {
+    date: string;
+    shared: [];
+    thread_icon: string;
+    thread_id: number;
+    thread_title: string;
+    title: string;
+    username: string;
+    _id: number;
+}
+export declare class LastInfosWidget {
+    loadInfos(maxResults: number): Promise<ILastInfosModel[]>;
+    getMaxResults(): Promise<number>;
+    setMaxResults(maxResults: number): Promise<void>;
+}

package/dist/widget/interfaces.d.ts

@@ -0,0 +1,53 @@
+import { IWidgetModel, WidgetPosition } from '../session/interfaces';
+export declare const WIDGET_NAME: {
+    readonly LAST_INFOS: "last-infos-widget";
+    readonly BIRTHDAY: "birthday";
+    readonly CALENDAR: "calendar-widget";
+    readonly CARNET: "carnet-de-bord";
+    readonly RECORD: "record-me";
+    readonly MOOD: "mood";
+    readonly MY_APPS: "my-apps";
+    readonly NOTES: "notes";
+    readonly RSS: "rss-widget";
+    readonly BOOKMARK: "bookmark-widget";
+    readonly QWANT: "qwant";
+    readonly QWANT_JUNIOR: "qwant-junior";
+    readonly AGENDA: "agenda-widget";
+    readonly CURSUS: "cursus-widget";
+    readonly MAXICOURS: "maxicours-widget";
+    readonly UNIVERSALIS: "universalis-widget";
+    readonly BRIEFME: "briefme-widget";
+    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>;
+    /** Save user preferences */
+    saveUserPrefs(): Promise<any>;
+    /** List widgets that are visible to the connected user. */
+    readonly list: IWidget[];
+    /** Retrieve a widget by name. */
+    lookup(widgetName: string): IWidget | undefined;
+}
+export interface IWidget {
+    /** The widgets conf at platform level. */
+    readonly platformConf: IWidgetModel;
+    /** The widgets conf at user level. */
+    readonly userPref: WidgetUserPref;
+}
+export type WidgetSpecificUserPrefs = 'schoolId';
+export type WidgetUserPref = {
+    /** Integer defining the sort order of this widget. */
+    index: number;
+    /** Boolean indicating wether the user wants to see this widget, or not. */
+    show: boolean;
+    /** Prefered position on-screen (left, right...). */
+    position?: WidgetPosition;
+} & {
+    [pref in WidgetSpecificUserPrefs]?: any;
+};
+export * from './LastInfos.widget';

package/dist/workspace/Service.d.ts

@@ -0,0 +1,75 @@
+import { ID } from '../globals';
+import { IOdeServices } from '../services/OdeServices';
+import { WorkspaceElement, WorkspaceSearchFilter, WorkspaceVisibility } from './interface';
+interface ElementQuery {
+    /**
+     * Keep only results having this criteria.
+     * Defaults to "owner" in backend but must be specified here for clarity.
+     */
+    filter: WorkspaceSearchFilter;
+    /** Restrict results to this element id only (kind of get). */
+    id?: ID;
+    /** Restrict results to element having this direct parent (folder). */
+    parentId?: ID;
+    /** Restrict results to elements having this ancestor (folder) at any level. */
+    ancestorId?: string;
+    /** Restrict results to the 1st folder hierarchy level. */
+    onlyRoot?: boolean;
+    /** Restrict results to this app. */
+    application?: string;
+    /** Restrict results to elements containing this text. */
+    search?: string;
+    /** Extend results to files AND folders. Defaults to false, with file results only. */
+    includeall?: boolean;
+    /** Max number of results needed. */
+    limit?: number;
+    /**
+     * Skip the first N results.
+     * Allows for pagination when used with the `limit` parameter.
+     */
+    skip?: number;
+    /**
+     * Restrict results to elements directly shared with the user.
+     * => Handle this param through a dedicated method. Do not expose it directly.
+     */
+    directShared?: boolean;
+    /**
+     * Truthy when result is a tree ?
+     * => Handle this param through a dedicated method. Do not expose it directly.
+     */
+    hierarchical?: boolean;
+}
+export declare class WorkspaceService {
+    private context;
+    constructor(context: IOdeServices);
+    private get http();
+    private extractMetadata;
+    saveFile(file: Blob | File, params?: {
+        parentId?: string;
+        visibility?: WorkspaceVisibility;
+        application?: string;
+    }): Promise<WorkspaceElement>;
+    updateFile(id: string, file: Blob | File, params?: {
+        alt?: string;
+        legend?: string;
+        name?: string;
+    }): Promise<any>;
+    deleteFile(elements: WorkspaceElement[]): Promise<void>;
+    private acceptDocuments;
+    searchDocuments(params: ElementQuery): Promise<WorkspaceElement[]>;
+    listDocuments(filter: WorkspaceSearchFilter, parentId?: ID): Promise<WorkspaceElement[]>;
+    /**
+     * Duplicate and transfers documents if needed to a different folder with the specified application and visibility.
+     * @param documents - The array of documents to transfer.
+     * @param application - The application to associate with the transferred documents.
+     * @param visibility - The visibility of the transferred documents. Defaults to "protected".
+     * @returns A Promise that resolves to an array of transferred WorkspaceElements.
+     */
+    transferDocuments(documents: WorkspaceElement[], application: string, visibility?: WorkspaceVisibility): Promise<WorkspaceElement[]>;
+    /**
+     * Get the URL of the thumbnail of a workspace element (or its URL),
+     * or `null` if none exists or can be created.
+     */
+    getThumbnailUrl(doc: WorkspaceElement | string, width?: number, height?: number): string | null;
+}
+export {};

package/dist/workspace/interface.d.ts

@@ -0,0 +1,67 @@
+export interface WorkspaceElement {
+    _id?: string;
+    eType: 'folder' | 'file' | string;
+    eParent: string;
+    name: string;
+    title?: string;
+    file?: string;
+    deleted?: boolean;
+    children: WorkspaceElement[];
+    created: Date;
+    trasher?: string;
+    externalId?: string;
+    _shared: any[];
+    inheritedShares?: any[];
+    _isShared: boolean;
+    showComments?: boolean;
+    editing?: boolean;
+    comments?: Comment[];
+    comment?: string;
+    ownerName?: string;
+    owner: {
+        userId: string;
+        displayName: string;
+    };
+    uploadStatus?: 'loading' | 'loaded' | 'failed' | 'abort';
+    uploadXhr?: XMLHttpRequest;
+    hiddenBlob?: Blob;
+    metadata?: {
+        'content-type'?: string;
+        'role'?: string;
+        'extension'?: string;
+        'filename'?: string;
+        'size'?: number;
+        'captation'?: boolean;
+        'duration'?: number;
+        'width'?: number;
+        'height'?: number;
+    };
+    link?: string;
+    icon?: string;
+    version?: number;
+    currentQuality?: number;
+    application?: string;
+    legend?: string;
+    alt?: string;
+    protected?: boolean;
+    public?: boolean;
+    /**
+     * Get multimedia thumbnails
+     * */
+    thumbnails?: {
+        [thumbSize: string]: string;
+    };
+}
+/** Supported view preferences */
+export type WorkspacePreferenceView = 'list' | 'icons' | 'carousel';
+export type WorkspaceVisibility = 'public' | 'protected';
+/** Workspace preferences */
+export interface WorkspacePreference {
+    sortField?: string;
+    sortDesc?: boolean;
+    view?: WorkspacePreferenceView;
+    bbmView?: WorkspacePreferenceView;
+    quickstart?: 'viewed' | 'notviewed';
+}
+/** Supported search filters */
+export type WorkspaceSearchFilter = 'owner' | 'shared' | 'protected' | 'public' | 'trash' | 'all' | 'external';

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@edifice.io/client",
+  "version": "1.7.4-develop-pedago.20241211160712",
+  "description": "Edifice TypeScript Client",
+  "homepage": "https://github.com/edificeio/edifice-frontend-framework/tree/main/packages/client#readme",
+  "bugs": {
+    "url": "https://github.com/edificeio/edifice-frontend-framework/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/edificeio/edifice-frontend-framework.git",
+    "directory": "packages/client"
+  },
+  "license": "AGPL-3.0",
+  "author": "Edifice",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "axios": "^1.7.7",
+    "core-js": "^3.35.1",
+    "@edifice.io/utilities": "1.7.4-develop-pedago.20241211160712"
+  },
+  "devDependencies": {
+    "@types/jasmine": "5.1.4",
+    "@types/node": "^22.9.1",
+    "jasmine": "5.1.0",
+    "rimraf": "5.0.5",
+    "rollup-plugin-visualizer": "5.12.0",
+    "typedoc": "0.25.7",
+    "typedoc-plugin-markdown": "3.17.1",
+    "vite": "^5.4.11",
+    "vite-plugin-dts": "^4.1.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "docs": "npx rimraf ./docs/ && npx typedoc src/ts/index.ts --excludePrivate --disableSources --plugin typedoc-plugin-markdown",
+    "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\""
+  }
+}