@api-client/core 0.4.4 → 0.5.0

package/src/runtime/store/SpacesSdk.ts

@@ -2,8 +2,8 @@ import { JsonPatch } from 'json8-patch';
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
 import { IListOptions, IListResponse } from '../../models/Backend.js';
-import { IWorkspace, IUserWorkspace, Workspace, Kind as WorkspaceKind } from '../../models/Workspace.js';
-import { UserAccessOperation } from '../../models/User.js';
+import { IWorkspace, Workspace, Kind as WorkspaceKind } from '../../models/Workspace.js';
+import { AccessOperation } from '../../models/store/Permission.js';
 
 export class SpacesSdk extends SdkBase {
   /**
@@ -65,7 +65,7 @@ export class SpacesSdk extends SdkBase {
    * @param key The user space key
    * @returns The definition of the user space.
    */
-  async read(key: string): Promise<IUserWorkspace> {
+  async read(key: string): Promise<IWorkspace> {
     const { token } = this.sdk;
     const url = this.sdk.getUrl(RouteBuilder.space(key));
     const result = await this.sdk.http.get(url.toString(), { token });
@@ -78,7 +78,7 @@ export class SpacesSdk extends SdkBase {
     if (!result.body) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
     }
-    let data: IUserWorkspace;
+    let data: IWorkspace;
     try {
       data = JSON.parse(result.body);
     } catch (e) {
@@ -145,7 +145,7 @@ export class SpacesSdk extends SdkBase {
    * @param key The user space key
    * @param value The patch operation on the space's ACL
    */
-  async patchUsers(key: string, value: UserAccessOperation[]): Promise<void> {
+  async patchUsers(key: string, value: AccessOperation[]): Promise<void> {
     const { token } = this.sdk;
     const url = this.sdk.getUrl(RouteBuilder.spaceUsers(key));
     const body = JSON.stringify(value);

package/src/runtime/store/UsersSdk.ts

@@ -1,7 +1,7 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
 import { IListOptions, IListResponse } from '../../models/Backend.js';
-import { IUser } from '../../models/User.js';
+import { IUser } from '../../models/store/User.js';
 
 export class UsersSdk extends SdkBase {
   async me(): Promise<IUser> {

package/build/src/models/User.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/models/User.ts"],"names":[],"mappings":"AAgEA,MAAM,CAAC,MAAM,IAAI,GAAG,WAAW,CAAC"}

package/src/models/User.ts

@@ -1,138 +0,0 @@
-export type AccessControlLevel = 'read' | 'comment' | 'write' | 'admin' | 'owner';
-
-/**
- * This is used in the communication with the backend to add/change user's access to the resource.
- */
-export interface IUserAccessOperation {
-  /**
-   * The user id.
-   */
-  uid: string;
-}
-
-export interface IUserAccessAddOperation extends IUserAccessOperation {
-  op: "add";
-  /**
-   * The level that the user has access to.
-   */
-  value: AccessControlLevel;
-}
-
-export interface IUserAccessRemoveOperation extends IUserAccessOperation {
-  op: "remove";
-}
-
-export type UserAccessOperation = IUserAccessAddOperation | IUserAccessRemoveOperation;
-
-/**
- * The definition of an access control.
- * The user may have access to a workspace so this is the object describing the level of the workspace.
- */
-export interface IAccessControl {
-  /**
-   * The data store key of the referenced object the user has access to.
-   */
-  key: string;
-  /**
-   * The level that the user has access to.
-   */
-  level: AccessControlLevel;
-}
-
-export interface IEmail {
-  /**
-   * When available the email of the user.
-   */
-  email?: string;
-  /**
-   * Whether the `email` was verified.
-   * Not verified emails should have limited use in the system.
-   */
-  verified?: boolean;
-}
-
-export interface IUserPicture {
-  /**
-   * When available, the URL to the user's picture image.
-   */
-  url?: string;
-  /**
-   * Alternative to the `imageUrl`. When set it is a data URL value of the image.
-   */
-  data?: string;
-}
-
-export const Kind = 'Core#User';
-
-interface BaseUser {
-  kind: typeof Kind;
-  /**
-   * Data store key of the user.
-   */
-  key: string;
-  /**
-   * The display name of the user.
-   */
-  name: string;
-  /**
-   * When available the email of the user.
-   */
-  email?: IEmail[];
-  /**
-   * The user picture to render.
-   */
-  picture?: IUserPicture;
-  /**
-   * General purpose tags field.
-   */
-  tags?: string[];
-  /**
-   * Optional user locale information.
-   */
-  locale?: string;
-  /**
-   * Optional metadata related to the auth provider.
-   */
-  provider?: unknown;
-}
-
-/**
- * Represents a user in the system.
- * This can be embedded in various situations like project's revision history,
- * ACL, Authorization, etc.
- * 
- * Note, the store implementation may have additional fields that support external 
- * identity providers. However, this is not exposed to the user through the API.
- */
-export interface IUser extends BaseUser {
-  /**
-   * Optional metadata related to the auth provider.
-   */
-  provider?: unknown;
-}
-
-/**
- * This object may be created for each user in the system.
- * It describes to which spaces user has access to.
- */
-export interface IUserSpaces {
-  /**
-   * The list of access to the spaces for the user.
-   */
-  spaces: IAccessControl[];
-  /**
-   * The data store key of the user that has access to the space.
-   * This is also the key of the entry.
-   */
-  user: string;
-}
-
-/**
- * An abstract user object that contains access information to a space.
- */
-export interface ISpaceUser extends BaseUser {
-  /**
-   * The level that the user has access to.
-   */
-  level: AccessControlLevel;
-}