ode-ts-client 1.2.1-develop-b2school.202311301157 → 1.2.1

package/dist/resources/BlogResourceService.d.ts

@@ -1,7 +1,8 @@
 import { ResourceType } from "..";
-import { BlogUpdate, UpdateResult } from "./interface";
+import { BlogUpdate, CreateParameters, CreateResult, UpdateResult } from "./interface";
 import { ResourceService } from "./ResourceService";
 export declare class BlogResourceService extends ResourceService {
+    create(parameters: CreateParameters): Promise<CreateResult>;
     update(parameters: BlogUpdate): Promise<UpdateResult>;
     getResourceType(): ResourceType;
     getApplication(): string;

package/dist/resources/MindmapResourceService.d.ts

@@ -0,0 +1,12 @@
+import { ResourceType } from "..";
+import { CreateParameters, CreateResult, MindmapUpdate, UpdateResult } from "./interface";
+import { ResourceService } from "./ResourceService";
+export declare class MindmapResourceService extends ResourceService {
+    create(parameters: CreateParameters): Promise<CreateResult>;
+    update(parameters: MindmapUpdate): Promise<UpdateResult>;
+    getResourceType(): ResourceType;
+    getApplication(): string;
+    getFormUrl(folderId?: string): string;
+    getViewUrl(resourceId: string): string;
+    getPrintUrl(resourceId: string, withComment?: boolean): string;
+}

package/dist/resources/ResourceService.d.ts

@@ -1,6 +1,6 @@
 import { PublishParameters, PublishResult, GetContextParameters, GetContextResult, ISearchResults, CreateFolderParameters, MoveParameters, IActionResult, TrashParameters, CreateFolderResult, UpdateFolderParameters, ID, GetSubFoldersResult, DeleteParameters, ResourceType } from "..";
 import { OdeServices } from "../services/OdeServices";
-import { UpdateParameters, UpdateResult } from "./interface";
+import { CreateParameters, CreateResult, UpdateParameters, UpdateResult } from "./interface";
 export declare abstract class ResourceService {
     protected context: OdeServices;
     private static registry;
@@ -21,6 +21,7 @@ export declare abstract class ResourceService {
     abstract getPrintUrl(resourceId: string, withComment?: boolean): string;
     abstract getViewUrl(resourceId: string): string;
     abstract getFormUrl(folderId?: string): string;
+    abstract create<T extends CreateParameters>(parameters: T): Promise<CreateResult>;
     abstract update<T extends UpdateParameters>(parameters: T): Promise<UpdateResult>;
     abstract getResourceType(): ResourceType;
     getShareReadUrl(id: string): string;

package/dist/resources/interface.d.ts

@@ -1,4 +1,18 @@
 import { IResource } from "..";
+/**
+ * Parameters expected to create resource
+ */
+export interface CreateParameters {
+    name: string;
+    description: string;
+    thumbnail: string | Blob | File;
+    folder: number | undefined;
+    public?: boolean;
+    slug?: string;
+    commentType?: string;
+    publishType?: string;
+    app?: string;
+}
 /**
  * Parameters expected to update resource
  */
@@ -11,6 +25,32 @@ export interface UpdateParameters {
     public: boolean;
     slug: string;
 }
+/**
+ * Response when creating resource
+ */
+export interface CreateResult {
+    entId: string;
+    thumbnail: string | undefined;
+    _id?: string;
+    title?: string;
+    description?: string;
+    visibility?: string;
+    trashed?: boolean;
+    "publish-type"?: string;
+    "comment-type"?: string;
+    created?: {
+        "$date": string;
+    };
+    modified?: {
+        "$date": string;
+    };
+    author?: {
+        userId: string;
+        username: string;
+        login: string;
+    };
+    shared?: Array<string>;
+}
 /**
  * Response when updating resource
  */
@@ -24,3 +64,9 @@ export interface BlogUpdate extends UpdateParameters {
 export interface BlogResource extends IResource {
     "publish-type": "RESTRAINT" | "IMMEDIATE";
 }
+export interface MindmapUpdate extends UpdateParameters {
+    "publish-type"?: "RESTRAINT" | "IMMEDIATE";
+}
+export interface MindmapResource extends IResource {
+    "publish-type": "RESTRAINT" | "IMMEDIATE";
+}

package/dist/rights/Service.d.ts

@@ -1,4 +1,4 @@
-import { RightStringified } from "../explore/interfaces";
+import { RightStringified } from "../explorer/interfaces";
 import { OdeServices } from "../services/OdeServices";
 import { ResourceRight, RightRole } from "./interface";
 export declare class RightService {

package/dist/version.txt

@@ -1 +1 @@
-ode-ts-client=1.2-develop-b2school-SNAPSHOT 30/11/2023 11:58:25
+ode-ts-client= 04/03/2024 10:52:02

package/dist/widget/interfaces.d.ts

@@ -18,6 +18,7 @@ export declare const WIDGET_NAME: {
     readonly UNIVERSALIS: "universalis-widget";
     readonly BRIEFME: "briefme-widget";
     readonly SCHOOL: "school-widget";
+    readonly EDUMALIN: "edumalin-widget";
 };
 export declare type WidgetName = (typeof WIDGET_NAME)[keyof typeof WIDGET_NAME];
 export declare abstract class WidgetFrameworkFactory {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ode-ts-client",
-  "version": "1.2.1-develop-b2school.202311301157",
+  "version": "1.2.1",
   "description": "Foundation frameworks by Open Digital Education",
   "homepage": "https://github.com/opendigitaleducation/ode-ts-client#readme",
   "bugs": {
@@ -25,38 +25,37 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "node scripts/build.mjs",
-    "docs": "npx rimraf ./docs/ && npx typedoc src/ts/index.ts --excludePrivate --disableSources --plugin typedoc-plugin-markdown",
-    "format": "yarn format:write && yarn format:check",
-    "format:check": "npx prettier --check \"src/ts/**/*.ts\"",
-    "format:write": "npx prettier --write \"src/ts/**/*.ts\"",
-    "prepare": "npx husky install",
-    "test": "node scripts/test.mjs && npx jasmine --config=src/test/config/jasmine.json",
-    "watch": "export build_target=${npm_config_build_target}; export watch=true; npx rollup -c --watch"
+  "dependencies": {
+    "axios": "0.21.1",
+    "core-js": "3.8.3",
+    "rxjs": "7.3.0"
   },
   "devDependencies": {
     "@types/jasmine": "3.6.3",
     "@types/node": "14.14.28",
-    "prettier": "2.8.4",
     "husky": "7.0.2",
     "jasmine": "3.6.4",
+    "prettier": "2.8.4",
     "rimraf": "3.0.2",
-    "typedoc": "0.22.13",
+    "rollup-plugin-visualizer": "5.9.0",
     "terser": "5.16.0",
+    "typedoc": "0.22.13",
     "typedoc-plugin-markdown": "3.11.14",
     "typescript": "4.6.4",
     "vite": "3.2.3",
-    "vite-plugin-dts": "1.7.1",
-    "rollup-plugin-visualizer": "5.9.0"
+    "vite-plugin-dts": "1.7.1"
   },
-  "dependencies": {
-    "axios": "0.21.1",
-    "core-js": "3.8.3",
-    "rxjs": "7.3.0"
-  },
-  "packageManager": "yarn@1.22.19",
+  "packageManager": "pnpm@8.6.6",
   "engines": {
-    "node": "16.x"
+    "node": "16 || 18"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "docs": "npx rimraf ./docs/ && npx typedoc src/ts/index.ts --excludePrivate --disableSources --plugin typedoc-plugin-markdown",
+    "format": "pnpm format:write && pnpm format:check",
+    "format:check": "npx prettier --check \"src/ts/**/*.ts\"",
+    "format:write": "npx prettier --write \"src/ts/**/*.ts\"",
+    "test": "node scripts/test.mjs && npx jasmine --config=src/test/config/jasmine.json",
+    "watch": "export build_target=${npm_config_build_target}; export watch=true; npx pnpm rollup -c --watch"
   }
-}
+}

package/dist/agents/blog.agent.d.ts

@@ -1,2 +0,0 @@
-import { AgentFactory } from ".";
-export declare const factory: AgentFactory;

package/dist/agents/folder.agent.d.ts

@@ -1,2 +0,0 @@
-import { AgentFactory } from ".";
-export declare const factory: AgentFactory;

package/dist/agents/index.d.ts

@@ -1,4 +0,0 @@
-import { IBusAgent } from "..";
-export declare type AgentFactory = () => IBusAgent;
-export { factory as blogAgentFactory } from "./blog.agent";
-export { factory as folderAgentFactory } from "./folder.agent";

package/dist/explore/Agent.d.ts

@@ -1,20 +0,0 @@
-import { ActionType, IActionParameters, IActionResult, IBusAgent, ResourceType } from "./interfaces";
-export declare type IHandler = (parameters: IActionParameters) => Promise<IActionResult>;
-/**
- * Manage a generic RESOURCE
- */
-export declare abstract class AbstractBusAgent implements IBusAgent {
-    constructor(managedResource: ResourceType);
-    /** Type of resource this agent can manage. */
-    protected managedResource: ResourceType;
-    protected static defaultHandler: IHandler;
-    protected handlerFor: {
-        [action in ActionType]: IHandler;
-    };
-    protected initialize(): void;
-    protected setHandler(action: ActionType, handler: IHandler): void;
-    protected getHandler(action: ActionType): IHandler;
-    /** Override to register handlers for actions this agent support. */
-    protected abstract registerHandlers(): void;
-    activate(res: ResourceType, action: ActionType, parameters: IActionParameters): Promise<IActionResult>;
-}

package/dist/explore/AgentLoader.d.ts

@@ -1,13 +0,0 @@
-import { ResourceType } from "./interfaces";
-/**
- * Inner representation of an agent loader, from the bus' perspective.
- */
-export interface IAgentLoader {
-    load(res: ResourceType): Promise<void>;
-}
-/**
- * Default implementation of the loader.
- */
-export declare class AgentLoader implements IAgentLoader {
-    load(res: ResourceType): Promise<void>;
-}

package/dist/explore/Bus.d.ts

@@ -1,20 +0,0 @@
-import { ActionType, IActionResult, IBus, ResourceType, IBusAgent } from "./interfaces";
-import { Observable } from "rxjs";
-import { IActionParameters } from "..";
-declare class Bus implements IBus {
-    private agents;
-    private comm;
-    setAgentFor(res: ResourceType, action: ActionType, agent: IBusAgent): void;
-    getAgentFor(res: ResourceType, action: ActionType): IBusAgent | null;
-    publish(res: ResourceType, action: ActionType, parameters: any): Promise<IActionResult>;
-    subscribe(res: ResourceType, action: ActionType): Observable<{
-        input: IActionParameters;
-        output: IActionResult;
-    }>;
-    private getActionMapping;
-}
-export declare class BusFactory {
-    private static _instance;
-    static get instance(): Bus;
-}
-export {};

package/dist/explore/Context.d.ts

@@ -1,33 +0,0 @@
-import { Observable } from "rxjs";
-import { App } from "../globals";
-import { IContext, IExplorerContext, ISearchParameters, ResourceType, GetResourcesResult, GetSubFoldersResult, CreateFolderResult, UpdateFolderResult, ID, ISearchResults, IResource, ManagePropertiesResult, UpdatePropertiesResult, PropKeyType, PublishParameters, PublishResult } from "./interfaces";
-export declare class ExplorerContext implements IExplorerContext {
-    private searchParameters;
-    private context;
-    private bus;
-    private latestResults;
-    constructor(types: ResourceType[], app: App);
-    clear(): void;
-    isInitialized(): boolean;
-    getContext(): IContext | undefined;
-    getSearchParameters(): ISearchParameters;
-    private duplicateSearchParameters;
-    latestResources(): Observable<{
-        input: ISearchParameters;
-        output: ISearchResults;
-    }>;
-    initialize(): Promise<IContext>;
-    getResources(): Promise<GetResourcesResult>;
-    getSubFolders(parentId: string): Promise<GetSubFoldersResult>;
-    createFolder(resourceType: ResourceType, parentId: string, name: string): Promise<CreateFolderResult>;
-    updateFolder(folderId: ID, resourceType: ResourceType, parentId: ID | "default", name: string): Promise<UpdateFolderResult>;
-    copy(targetId: string, resourceIds: ID[], folderIds: ID[]): Promise<void>;
-    move(targetId: string, resourceIds: ID[], folderIds: ID[]): Promise<void>;
-    delete(resourceIds: string[], folderIds: string[]): Promise<void>;
-    trash(trash: boolean, resourceIds: string[], folderIds: string[]): Promise<void>;
-    manageProperties(resourceType: ResourceType, resources: IResource[]): Promise<ManagePropertiesResult>;
-    updateProperties(resourceType: ResourceType, resources: IResource[], props: {
-        [key in PropKeyType]?: string;
-    }): Promise<UpdatePropertiesResult>;
-    publish(resourceType: ResourceType, parameters: PublishParameters): Promise<PublishResult>;
-}

package/dist/explore/Framework.d.ts

@@ -1,15 +0,0 @@
-import { IBusAgent } from "..";
-import { App } from "../globals";
-import { IAgentLoader } from "./AgentLoader";
-import { ActionType, IBus, IExplorerContext, IExplorerFramework, ResourceType } from "./interfaces";
-export declare class ExplorerFramework implements IExplorerFramework {
-    private _agentLoader?;
-    get agentLoader(): IAgentLoader;
-    setAgentLoader(loader: IAgentLoader): void;
-    /** Load the agent dedicated to resolve this @param action on this @param resource */
-    requestAgentFor(resource: ResourceType, action: ActionType): Promise<IBusAgent>;
-    createContext(types: ResourceType[], app: App): IExplorerContext;
-    getBus(): IBus;
-}
-/** The whole framework is a singleton. */
-export declare const explorer: IExplorerFramework;