@opencloud-eu/web-client 7.1.2 → 7.2.0

package/dist/src/graph/generated/api.d.ts

@@ -403,10 +403,15 @@ export interface DriveItem {
     'permissions'?: Array<Permission>;
     'audio'?: Audio;
     'video'?: Video;
+    '@libre.graph.motionPhoto'?: MotionPhoto;
     /**
      * Indicates if the item is synchronized with the underlying storage provider. Read-only.
      */
     '@client.synchronize'?: boolean;
+    /**
+     * A pre-authenticated URL that can be used to download the item\'s content without providing an Authorization header. The URL is short-lived and cannot be cached.  This annotation is only populated when explicitly requested via `$select`, and only for items that have a `file` facet. The returned URL is valid for a limited time and should be used promptly.
+     */
+    '@microsoft.graph.downloadUrl'?: string;
     /**
      * Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true. Users can set this to hide permissions.
      */
@@ -886,6 +891,23 @@ export interface ItemReference {
 export interface MemberReference {
     '@odata.id'?: string;
 }
+/**
+ * Motion Photo metadata. A Motion Photo is a still image with a short video clip appended to the end of the file. The presence of this facet on a driveItem indicates that the item is a Motion Photo; absence indicates it is not.  Based on the Google Motion Photo format v1.0 specification: https://developer.android.com/media/platform/motion-photo-format
+ */
+export interface MotionPhoto {
+    /**
+     * The file format version of the Motion Photo. Currently always 1. Read-only.
+     */
+    'version'?: number;
+    /**
+     * Presentation timestamp in microseconds of the video frame that corresponds to the still image. A value of -1 indicates unspecified. If absent, readers should use a timestamp near the middle of the video track. Read-only.
+     */
+    'presentationTimestampUs'?: number;
+    /**
+     * Size in bytes of the embedded video portion of the file. The video is appended at the end of the file, so clients can fetch it with a Range request: `Range: bytes=<fileSize - videoSize>-`. Read-only.
+     */
+    'videoSize'?: number;
+}
 /**
  * Represents an identity used to sign in to a user account
  */
@@ -1599,10 +1621,20 @@ export declare const DriveItemApiAxiosParamCreator: (configuration?: Configurati
      * @summary Get a DriveItem.
      * @param {string} driveId key: id of drive
      * @param {string} itemId key: id of item
+     * @param {Set<GetDriveItemSelectEnum>} [$select] Select additional properties to be returned.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDriveItem: (driveId: string, itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getDriveItem: (driveId: string, itemId: string, $select?: Set<GetDriveItemSelectEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Download the contents of the primary stream (file) of a driveItem. Only driveItem objects with a `file` facet can be downloaded.  The response is a `302 Found` redirecting to a pre-authenticated download URL for the file. This is the same URL that is returned via the `@microsoft.graph.downloadUrl` instance annotation on the driveItem when requested via `$select`. Choose between the two based on whether you want to call the redirecting `/content` endpoint directly (for example, with a client that follows redirects automatically) or you want to inspect / schedule / prefetch the URL yourself via the annotation.  The pre-authenticated URL is short-lived and does not require an `Authorization` header.  To download a partial range of bytes, apply the `Range` header to the redirect target (the pre-authenticated URL), not to the `/content` request.
+     * @summary Download the content of a DriveItem
+     * @param {string} driveId key: id of drive
+     * @param {string} itemId key: id of item
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDriveItemContent: (driveId: string, itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update a DriveItem.  The request body must include a JSON object with the properties to update. Only the properties that are provided will be updated.  Currently it supports updating the following properties:  * `@UI.Hidden` - Hides the item from the UI.
      * @summary Update a DriveItem.
@@ -1632,10 +1664,20 @@ export declare const DriveItemApiFp: (configuration?: Configuration) => {
      * @summary Get a DriveItem.
      * @param {string} driveId key: id of drive
      * @param {string} itemId key: id of item
+     * @param {Set<GetDriveItemSelectEnum>} [$select] Select additional properties to be returned.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDriveItem(driveId: string, itemId: string, $select?: Set<GetDriveItemSelectEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DriveItem>>;
+    /**
+     * Download the contents of the primary stream (file) of a driveItem. Only driveItem objects with a `file` facet can be downloaded.  The response is a `302 Found` redirecting to a pre-authenticated download URL for the file. This is the same URL that is returned via the `@microsoft.graph.downloadUrl` instance annotation on the driveItem when requested via `$select`. Choose between the two based on whether you want to call the redirecting `/content` endpoint directly (for example, with a client that follows redirects automatically) or you want to inspect / schedule / prefetch the URL yourself via the annotation.  The pre-authenticated URL is short-lived and does not require an `Authorization` header.  To download a partial range of bytes, apply the `Range` header to the redirect target (the pre-authenticated URL), not to the `/content` request.
+     * @summary Download the content of a DriveItem
+     * @param {string} driveId key: id of drive
+     * @param {string} itemId key: id of item
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDriveItem(driveId: string, itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DriveItem>>;
+    getDriveItemContent(driveId: string, itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OdataError>>;
     /**
      * Update a DriveItem.  The request body must include a JSON object with the properties to update. Only the properties that are provided will be updated.  Currently it supports updating the following properties:  * `@UI.Hidden` - Hides the item from the UI.
      * @summary Update a DriveItem.
@@ -1665,10 +1707,20 @@ export declare const DriveItemApiFactory: (configuration?: Configuration, basePa
      * @summary Get a DriveItem.
      * @param {string} driveId key: id of drive
      * @param {string} itemId key: id of item
+     * @param {Set<GetDriveItemSelectEnum>} [$select] Select additional properties to be returned.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDriveItem(driveId: string, itemId: string, $select?: Set<GetDriveItemSelectEnum>, options?: RawAxiosRequestConfig): AxiosPromise<DriveItem>;
+    /**
+     * Download the contents of the primary stream (file) of a driveItem. Only driveItem objects with a `file` facet can be downloaded.  The response is a `302 Found` redirecting to a pre-authenticated download URL for the file. This is the same URL that is returned via the `@microsoft.graph.downloadUrl` instance annotation on the driveItem when requested via `$select`. Choose between the two based on whether you want to call the redirecting `/content` endpoint directly (for example, with a client that follows redirects automatically) or you want to inspect / schedule / prefetch the URL yourself via the annotation.  The pre-authenticated URL is short-lived and does not require an `Authorization` header.  To download a partial range of bytes, apply the `Range` header to the redirect target (the pre-authenticated URL), not to the `/content` request.
+     * @summary Download the content of a DriveItem
+     * @param {string} driveId key: id of drive
+     * @param {string} itemId key: id of item
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDriveItem(driveId: string, itemId: string, options?: RawAxiosRequestConfig): AxiosPromise<DriveItem>;
+    getDriveItemContent(driveId: string, itemId: string, options?: RawAxiosRequestConfig): AxiosPromise<OdataError>;
     /**
      * Update a DriveItem.  The request body must include a JSON object with the properties to update. Only the properties that are provided will be updated.  Currently it supports updating the following properties:  * `@UI.Hidden` - Hides the item from the UI.
      * @summary Update a DriveItem.
@@ -1698,10 +1750,20 @@ export declare class DriveItemApi extends BaseAPI {
      * @summary Get a DriveItem.
      * @param {string} driveId key: id of drive
      * @param {string} itemId key: id of item
+     * @param {Set<GetDriveItemSelectEnum>} [$select] Select additional properties to be returned.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDriveItem(driveId: string, itemId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DriveItem, any, {}>>;
+    getDriveItem(driveId: string, itemId: string, $select?: Set<GetDriveItemSelectEnum>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DriveItem, any, {}>>;
+    /**
+     * Download the contents of the primary stream (file) of a driveItem. Only driveItem objects with a `file` facet can be downloaded.  The response is a `302 Found` redirecting to a pre-authenticated download URL for the file. This is the same URL that is returned via the `@microsoft.graph.downloadUrl` instance annotation on the driveItem when requested via `$select`. Choose between the two based on whether you want to call the redirecting `/content` endpoint directly (for example, with a client that follows redirects automatically) or you want to inspect / schedule / prefetch the URL yourself via the annotation.  The pre-authenticated URL is short-lived and does not require an `Authorization` header.  To download a partial range of bytes, apply the `Range` header to the redirect target (the pre-authenticated URL), not to the `/content` request.
+     * @summary Download the content of a DriveItem
+     * @param {string} driveId key: id of drive
+     * @param {string} itemId key: id of item
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDriveItemContent(driveId: string, itemId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OdataError, any, {}>>;
     /**
      * Update a DriveItem.  The request body must include a JSON object with the properties to update. Only the properties that are provided will be updated.  Currently it supports updating the following properties:  * `@UI.Hidden` - Hides the item from the UI.
      * @summary Update a DriveItem.
@@ -1713,6 +1775,10 @@ export declare class DriveItemApi extends BaseAPI {
      */
     updateDriveItem(driveId: string, itemId: string, driveItem: DriveItem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DriveItem, any, {}>>;
 }
+export declare const GetDriveItemSelectEnum: {
+    readonly MicrosoftGraphDownloadUrl: "@microsoft.graph.downloadUrl";
+};
+export type GetDriveItemSelectEnum = typeof GetDriveItemSelectEnum[keyof typeof GetDriveItemSelectEnum];
 /**
  * DrivesApi - axios parameter creator
  */

package/dist/src/helpers/resource/types.d.ts

@@ -41,6 +41,7 @@ export interface Resource {
     extraProps?: Record<string, unknown>;
     remoteItemId?: string;
     remoteItemPath?: string;
+    isInVault?: boolean;
     hasPreview?(): boolean;
     canCreate?(): boolean;
     canUpload?({ user }: {
@@ -60,6 +61,9 @@ export interface Resource {
         ability?: Ability;
     }): boolean;
     canEditTags?(): boolean;
+    canListVersions?(args?: {
+        user?: User;
+    }): boolean;
     getDomSelector?(): string;
     isReceivedShare?(): boolean;
     isShareRoot?(): boolean;

package/dist/src/helpers/share/type.d.ts

@@ -15,6 +15,7 @@ export declare abstract class ShareTypes {
     static readonly link: ShareType;
     static readonly guest: ShareType;
     static readonly remote: ShareType;
+    static readonly contact: ShareType;
     static readonly individuals: ShareType[];
     static readonly collectives: ShareType[];
     static readonly unauthenticated: ShareType[];

package/dist/src/helpers/space/functions.d.ts

@@ -1,7 +1,7 @@
 import { Resource } from '../resource';
 import { PublicSpaceResource, ShareSpaceResource, SpaceResource } from './types';
 import { Drive } from '@opencloud-eu/web-client/graph/generated';
-import { CollaboratorShare, ShareRole } from '../share';
+import { CollaboratorShare, GraphSharePermission, ShareRole } from '../share';
 export declare function buildWebDavSpacesPath(storageId: string, path?: string): string;
 export declare function buildWebDavSpacesTrashPath(storageId: string, path?: string): string;
 export declare function getRelativeSpecialFolderSpacePath(space: SpaceResource, type: 'image' | 'readme'): string;
@@ -11,11 +11,12 @@ export type PublicLinkType = 'ocm' | 'public-link';
 export declare function buildPublicSpaceResource(data: any & {
     publicLinkType: PublicLinkType;
 }): PublicSpaceResource;
-export declare function buildShareSpaceResource({ driveAliasPrefix, id, shareName, serverUrl }: {
+export declare function buildShareSpaceResource({ driveAliasPrefix, id, shareName, serverUrl, graphPermissions }: {
     driveAliasPrefix: 'share' | 'ocm-share';
     id: string;
     shareName: string;
     serverUrl: string;
+    graphPermissions?: GraphSharePermission[];
 }): ShareSpaceResource;
 export declare function buildSpace(data: Drive & {
     path?: string;

package/dist/src/helpers/space/types.d.ts

@@ -39,9 +39,6 @@ export interface SpaceResource extends Resource {
     canRestoreFromTrashbin(args?: {
         user?: User;
     }): boolean;
-    canListVersions(args?: {
-        user?: User;
-    }): boolean;
     getWebDavUrl({ path }: {
         path: string;
     }): string;

package/dist/src/index.d.ts

@@ -1,7 +1,8 @@
 import { graph } from './graph';
 import { ocs } from './ocs';
+import { ox } from './ox';
 import { webdav } from './webdav';
 export * from './errors';
 export * from './helpers';
 export * from './utils';
-export { graph, ocs, webdav };
+export { graph, ocs, ox, webdav };

package/dist/src/ox/index.d.ts

@@ -0,0 +1,27 @@
+import { AxiosInstance } from 'axios';
+import { Contact } from './types';
+export * from './types';
+export interface OXMailRecipient {
+    name?: string;
+    email: string;
+}
+export interface OX {
+    autocompleteContacts(args: {
+        query: string;
+        signal?: AbortSignal;
+    }): Promise<Contact[]>;
+    sendMail(args: {
+        from: OXMailRecipient;
+        to: OXMailRecipient;
+        subject: string;
+        htmlContent: string;
+        signal?: AbortSignal;
+    }): Promise<void>;
+}
+/**
+ * Client for the Open-Xchange middleware HTTP API.
+ *
+ * The base url is resolved lazily through `getApiUrl` because it originates from
+ * a config option that is only available after the app has bootstrapped.
+ */
+export declare const ox: (axiosClient: AxiosInstance, getApiUrl: () => string | undefined) => OX;

package/dist/src/ox/types.d.ts

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+/**
+ * A contact as returned by the Open-Xchange addressbook autocomplete endpoint,
+ * normalized into a flat object.
+ */
+export declare const ContactSchema: z.ZodObject<{
+    id: z.ZodString;
+    displayName: z.ZodString;
+    email: z.ZodString;
+}, z.core.$strip>;
+export type Contact = z.infer<typeof ContactSchema>;
+/**
+ * Raw envelope of the Open-Xchange autocomplete response. `data` is a list of
+ * column-value arrays, ordered according to the requested `columns` parameter.
+ * @see https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Addressbooks/doAutoCompleteContactsFromAddressbook
+ */
+export declare const OxAutocompleteResponseSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNull]>>>;
+}, z.core.$strip>;
+/**
+ * Response of opening an Open-Xchange mail composition space. `data.id`
+ * identifies the space used for the subsequent send call.
+ * @see https://documentation.open-xchange.com/8.21/middleware/mail/mail_compose.html
+ */
+export declare const OxComposeSpaceResponseSchema: z.ZodObject<{
+    data: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;

package/dist/src/sse/index.d.ts

@@ -12,6 +12,7 @@ export declare enum MESSAGE_TYPE {
     FOLDER_CREATED = "folder-created",
     SPACE_CREATED = "space-created",
     SPACE_DISABLED = "space-disabled",
+    SPACE_ENABLED = "space-enabled",
     SPACE_DELETED = "space-deleted",
     SPACE_MEMBER_ADDED = "space-member-added",
     SPACE_MEMBER_REMOVED = "space-member-removed",