@api-client/core 0.12.7 → 0.12.9

package/data/models/example-generator-api.json

@@ -42470,13 +42470,13 @@
 "@id": "#219"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
-"@id": "#213"
+"@id": "#210"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
 "@id": "#219"
@@ -43892,7 +43892,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43913,7 +43913,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43934,7 +43934,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44781,12 +44781,12 @@
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",

package/eslint.config.js

@@ -2,7 +2,7 @@ import globals from 'globals'
 import pluginJs from '@eslint/js'
 import tseslint from 'typescript-eslint'
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
-import noOnlyTests from 'eslint-plugin-no-only-tests';
+import noOnlyTests from 'eslint-plugin-no-only-tests'
 // import eslintPluginPrettier from 'eslint-plugin-prettier'
 
 // import eslintConfigPrettier from 'eslint-config-prettier'
@@ -21,8 +21,8 @@ export const GLOBAL_IGNORE_LIST = [
   'coverage/',
   'node_modules',
   'scripts/',
-  'test/',
-  'eslint.config.js',
+  // 'test/',
+  // 'eslint.config.js',
   '*.min.*',
   '*.d.ts',
   'CHANGELOG.md',
@@ -81,7 +81,7 @@ export default [
       'src/lib/calculators/DataCalculator.ts',
       'src/lib/Buffer.ts',
       'src/events/amf/AmfEvents.ts',
-      'src/authorization/lib/SecurityProcessor.ts'
+      'src/authorization/lib/SecurityProcessor.ts',
     ],
     languageOptions: {
       globals: {
@@ -101,12 +101,13 @@ export default [
   {
     files: ['tests/**/*.ts', 'test/**/*.ts'],
     plugins: {
-      "no-only-tests": noOnlyTests,
+      'no-only-tests': noOnlyTests,
     },
     rules: {
       '@typescript-eslint/no-non-null-assertion': 'off',
       '@typescript-eslint/no-empty-function': 'off',
       'no-only-tests/no-only-tests': 'error',
+      'no-console': ['warn'],
     },
   },
   {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.12.7",
+  "version": "0.12.9",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -144,8 +144,6 @@
     "build:ts": "wireit",
     "build:node": "wireit",
     "build": "npm run build:ts && npm run lint && npm run copy:assets",
-    "lint": "wireit",
-    "lint:old": "tsc --noEmit && eslint \"**/*.{js,ts}\" --quiet --fix",
     "prepare": "husky && npm run fixes && npm run build:ts && npm run build:api-models",
     "fixes": "node scripts/fix-rollup-plugin.js",
     "tsc": "wireit",
@@ -159,7 +157,13 @@
     "test:node:watch": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts --watch",
     "build:api-models": "node data/model.js",
     "copy:assets": "cp -f ./oauth-popup.html ./build/oauth-popup.html",
-    "start": "echo \"Use the npm run dev instead\""
+    "start": "echo \"Use the npm run dev instead\"",
+    "lint": "npm run lint:prettier && npm run lint:eslint",
+    "lint:eslint": "wireit",
+    "lint:prettier": "wireit",
+    "format": "npm run format:prettier && npm run format:prettier",
+    "format:prettier": "wireit",
+    "format:eslint": "wireit"
   },
   "wireit": {
     "test": {
@@ -242,13 +246,27 @@
         ".tsbuildinfo"
       ]
     },
-    "lint": {
+    "lint:eslint": {
       "command": "eslint --color --cache --cache-location .eslintcache .",
       "files": [
         "src/**/*.ts",
         "eslint.config.js"
       ],
       "output": []
+    },
+    "lint:prettier": {
+      "command": "prettier \"**/*.ts\" --check"
+    },
+    "format:eslint": {
+      "command": "eslint --color --cache --fix --cache-location .eslintcache .",
+      "files": [
+        "src/**/*.ts",
+        "eslint.config.js"
+      ],
+      "output": []
+    },
+    "format:prettier": {
+      "command": "prettier \"**/*.ts\" --write"
     }
   },
   "husky": {

package/src/models/kinds.ts

@@ -18,6 +18,8 @@ export const DomainAssociationKind = 'Domain#Association'
 export const DomainPropertyKind = 'Domain#Property'
 export const DataCatalogKind = 'Core#DataCatalog'
 export const DataCatalogVersionKind = 'Core#DataCatalogVersion'
+export const OrganizationKind = 'Core#Organization'
+export const InvitationKind = 'Core#Invitation'
 
 /**
  * @deprecated Not used anymore.

package/src/models/store/Invitation.ts

@@ -0,0 +1,287 @@
+import { nanoid } from 'nanoid'
+import { InvitationKind } from '../kinds.js'
+import type { IDeletion } from './Deletion.js'
+import type { UserOrganizationGrantType } from './Organization.js'
+import type { Operation } from '@api-client/json/types.js'
+import { Builder } from '@api-client/json/patch/builder.js'
+
+/**
+ * The status of an invitation.
+ * - `pending`: The invitation has been sent but not yet responded to.
+ * - `accepted`: The invitation has been accepted by the user.
+ * - `declined`: The invitation has been declined by the user.
+ */
+export type InvitationStatus = 'pending' | 'accepted' | 'declined'
+
+/**
+ * The schema for an invitation.
+ * This defines the structure of an invitation object in the system.
+ */
+export interface InvitationSchema {
+  /**
+   * The kind of the invitation.
+   */
+  kind: typeof InvitationKind
+  /**
+   * The database ID of the invitation.
+   */
+  key: string
+  /**
+   * The user ID of the user who sent the invitation.
+   */
+  uid: string
+  /**
+   * The organization ID to which the invitation belongs.
+   */
+  oid: string
+  /**
+   * The email address of the user to whom the invitation is sent.
+   */
+  email: string
+  /**
+   * The name of the user to whom the invitation is sent.
+   * This is optional and can be empty if the user is not known.
+   */
+  name?: string
+  /**
+   * The token used to respond to the invitation.
+   */
+  token: string
+  /**
+   * The timestamp when the invitation expires.
+   * This is used to determine if the invitation is still valid.
+   */
+  expiresAt: number
+  /**
+   * The timestamp when the invitation was responded to.
+   * This is set when the user accepts or declines the invitation.
+   */
+  respondedAt?: number
+  /**
+   * The status of the invitation.
+   */
+  status: InvitationStatus
+  /**
+   * The grant type the user will have in the organization if they accept the invitation.
+   */
+  grantType: UserOrganizationGrantType
+  /**
+   * Whether the file object is deleted.
+   */
+  deleted?: boolean
+  /**
+   * The information about the delete information.
+   * Always set when the `delete` is true.
+   */
+  deletedInfo?: IDeletion
+  /**
+   * The timestamp when the invitation was created.
+   */
+  createdAt: number
+  /**
+   * The timestamp when the invitation was last updated.
+   */
+  updatedAt: number
+}
+
+/**
+ * Represents an invitation to join an organization.
+ * This class implements the `InvitationSchema` interface and provides methods to create and manipulate invitations.
+ */
+export class Invitation implements InvitationSchema {
+  kind: typeof InvitationKind
+  key: string
+  uid: string
+  oid: string
+  email: string
+  name: string | undefined
+  token: string
+  expiresAt: number
+  respondedAt: number | undefined
+  status: InvitationStatus
+  grantType: UserOrganizationGrantType
+  deleted: boolean
+  deletedInfo: IDeletion | undefined
+  createdAt: number
+  updatedAt: number
+
+  #builder?: Builder<InvitationSchema>
+
+  /**
+   * The patch builder for this invitation.
+   */
+  get builder(): Builder<InvitationSchema> {
+    if (!this.#builder) {
+      this.#builder = new Builder(this.toJSON())
+    }
+    return this.#builder
+  }
+
+  /**
+   * Creates a full invitation schema with defaults.
+   *
+   * @param input The partial invitation schema.
+   * @returns The invitation schema.
+   */
+  static createSchema(input: Partial<InvitationSchema> = {}): InvitationSchema {
+    const {
+      key = nanoid(),
+      email,
+      oid,
+      grantType,
+      uid = '',
+      updatedAt = 0,
+      createdAt = 0,
+      expiresAt = 0,
+      status = 'pending',
+      token = '',
+    } = input
+    if (!email) {
+      throw new Error('Email is required to create an invitation schema.')
+    }
+    if (!oid) {
+      throw new Error('Organization ID is required to create an invitation schema.')
+    }
+    if (!grantType) {
+      throw new Error('Grant type is required to create an invitation schema.')
+    }
+    const result: InvitationSchema = {
+      kind: InvitationKind,
+      key,
+      uid,
+      oid,
+      email,
+      grantType,
+      token,
+      expiresAt,
+      status,
+      createdAt,
+      updatedAt,
+    }
+    if (input.name) {
+      result.name = input.name
+    }
+    if (input.token) {
+      result.token = input.token
+    }
+    if (input.expiresAt) {
+      result.expiresAt = input.expiresAt
+    }
+    if (input.respondedAt) {
+      result.respondedAt = input.respondedAt
+    }
+    if (input.status) {
+      result.status = input.status
+    }
+    if (input.deleted) {
+      result.deleted = input.deleted
+      result.deletedInfo = input.deletedInfo
+    }
+    return result
+  }
+
+  constructor(input?: Partial<InvitationSchema>) {
+    const init: InvitationSchema = Invitation.createSchema(input)
+    this.kind = InvitationKind
+    this.key = init.key
+    this.uid = init.uid
+    this.oid = init.oid
+    this.email = init.email
+    this.name = init.name
+    this.token = init.token
+    this.expiresAt = init.expiresAt
+    this.respondedAt = init.respondedAt
+    this.status = init.status
+    this.grantType = init.grantType
+    this.deleted = init.deleted || false
+    this.deletedInfo = init.deletedInfo
+    this.createdAt = init.createdAt
+    this.updatedAt = init.updatedAt
+  }
+
+  toJSON(): InvitationSchema {
+    const result: InvitationSchema = {
+      kind: this.kind,
+      key: this.key,
+      uid: this.uid,
+      oid: this.oid,
+      email: this.email,
+      token: this.token,
+      expiresAt: this.expiresAt,
+      status: this.status,
+      grantType: this.grantType,
+      deleted: this.deleted,
+      createdAt: this.createdAt,
+      updatedAt: this.updatedAt,
+    }
+    if (this.name) {
+      result.name = this.name
+    }
+    if (this.respondedAt) {
+      result.respondedAt = this.respondedAt
+    }
+    if (this.deletedInfo) {
+      result.deletedInfo = { ...this.deletedInfo }
+    }
+    return result
+  }
+
+  /**
+   * Retrieves the patch operations for this invitation.
+   * This method builds a JSON Patch representation of the invitation,
+   * which can be used to update the invitation in a database or API.
+   *
+   * Use one of the `set*` methods to modify the invitation before calling this method.
+   *
+   * @returns An array of patch operations.
+   * If no changes have been made, it returns an empty array.
+   */
+  getPatch(): Operation[] {
+    if (!this.#builder) {
+      return []
+    }
+    return this.builder.build()
+  }
+
+  /**
+   * Sets the name of the user to whom the invitation is sent.
+   * If the name is the same as the current name, no operation is performed.
+   *
+   * @param name The name to set. If undefined, it will be removed.
+   */
+  setName(name?: string): void {
+    if (name === this.name) {
+      return
+    }
+    const hasName = !!this.name
+    if (hasName && !name) {
+      this.builder.remove('/name')
+    } else {
+      // The add method handles both adding and replacing
+      this.builder.add('/name', name)
+    }
+    this.name = name
+  }
+
+  /**
+   * Sets the expiration timestamp of the invitation.
+   * @param expiresAt The timestamp when the invitation expires.
+   * If the expiresAt is the same as the current expiresAt, no operation is performed.
+   */
+  setExpiresAt(expiresAt: number): void {
+    if (this.expiresAt !== expiresAt) {
+      this.builder.replace('/expiresAt', expiresAt)
+      this.expiresAt = expiresAt
+    }
+  }
+
+  /**
+   * Sets the grant type of the user in the organization.
+   */
+  setGrantType(grantType: UserOrganizationGrantType): void {
+    if (this.grantType !== grantType) {
+      this.builder.replace('/grantType', grantType)
+      this.grantType = grantType
+    }
+  }
+}

package/src/models/store/Organization.ts

@@ -1,9 +1,8 @@
 import { nanoid } from 'nanoid'
 import type { IDeletion } from './Deletion.js'
+import { OrganizationKind } from '../kinds.js'
 
-export const Kind = 'Core#Organization'
-
-export type UserOrganizationGrantType = 'owner' | 'member'
+export type UserOrganizationGrantType = 'owner' | 'manager' | 'editor' | 'viewer'
 
 /**
  * In the system the user identity represents registration information associated with a specific identity provider.
@@ -11,7 +10,7 @@ export type UserOrganizationGrantType = 'owner' | 'member'
  * email stays consistent.
  */
 export interface IOrganization {
-  kind: typeof Kind
+  kind: typeof OrganizationKind
   /**
    * The database ID
    */
@@ -45,14 +44,14 @@ export interface IOrganization {
 }
 
 export class Organization implements IOrganization {
-  kind: typeof Kind = Kind
+  kind: typeof OrganizationKind = OrganizationKind
   key = ''
   name = ''
   createdBy = ''
   createdDate = 0
   deleted = false
   deletedInfo?: IDeletion
-  grantType: UserOrganizationGrantType = 'member'
+  grantType: UserOrganizationGrantType = 'viewer'
 
   constructor(input?: string | IOrganization) {
     let init: IOrganization
@@ -62,13 +61,13 @@ export class Organization implements IOrganization {
       init = input
     } else {
       init = {
-        kind: Kind,
+        kind: OrganizationKind,
         key: nanoid(),
         name: '',
         createdBy: '',
         createdDate: Date.now(),
         deleted: false,
-        grantType: 'member',
+        grantType: 'viewer',
       }
     }
     this.new(init)
@@ -85,9 +84,9 @@ export class Organization implements IOrganization {
       createdDate = Date.now(),
       deleted = false,
       deletedInfo,
-      grantType = 'member',
+      grantType = 'viewer',
     } = init
-    this.kind = Kind
+    this.kind = OrganizationKind
     this.key = key
     this.name = name
     this.createdBy = createdBy
@@ -106,7 +105,7 @@ export class Organization implements IOrganization {
    */
   static isOrganization(input: unknown): boolean {
     const typed = input as IOrganization
-    if (!input || typed.kind !== Kind) {
+    if (!input || typed.kind !== OrganizationKind) {
       return false
     }
     return true
@@ -114,7 +113,7 @@ export class Organization implements IOrganization {
 
   toJSON(): IOrganization {
     const result: IOrganization = {
-      kind: Kind,
+      kind: OrganizationKind,
       key: this.key,
       name: this.name,
       createdBy: this.createdBy,

package/src/runtime/store/HttpWeb.ts

@@ -11,14 +11,14 @@ export class HttpWeb extends Http {
    * @returns The response info.
    */
   async get(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
-    const { method = 'GET', headers = {}, token } = opts
-    const httpHeaders = { ...headers }
+    const { method = 'GET', headers = {}, token = this.sdk.token } = opts
+    const requestHeaders = new Headers({ ...headers })
     if (token) {
-      httpHeaders.authorization = `Bearer ${token}`
+      requestHeaders.append('Authorization', `Bearer ${token}`)
     }
     const init: RequestInit = {
       method,
-      headers: httpHeaders,
+      headers: requestHeaders.toJSON(),
       redirect: 'follow',
       credentials: 'include',
       mode: 'cors',
@@ -45,7 +45,7 @@ export class HttpWeb extends Http {
   }
 
   async post(url: string, opts: IStoreRequestOptions = {}): Promise<IStoreResponse> {
-    const { method = 'POST', headers = {}, token } = opts
+    const { method = 'POST', headers = {}, token = this.sdk.token } = opts
     const requestHeaders = new Headers({ ...headers })
     if (token) {
       requestHeaders.append('Authorization', `Bearer ${token}`)