@staffbase/widget-sdk 3.3.4 → 3.4.0-alpha.15

package/docs/Interface: SBUserAvatar.md

@@ -1,27 +0,0 @@
-# Interface: SBUserAvatar
-
-User avatar definition
-
-## Properties
-
-### icon
-
-• **icon**: [*SBImageEntity*](../wiki/Interface:%20SBImageEntity)
-
-___
-
-### original
-
-• **original**: [*SBImageEntity*](../wiki/Interface:%20SBImageEntity)
-
-___
-
-### publicID
-
-• **publicID**: *string*
-
-___
-
-### thumb
-
-• **thumb**: [*SBImageEntity*](../wiki/Interface:%20SBImageEntity)

package/docs/Interface: SBUserProfile.md

@@ -1,51 +0,0 @@
-# Interface: SBUserProfile
-
-User profile data
-
-## Properties
-
-### avatar
-
-• `Optional` **avatar**: [*SBUserAvatar*](../wiki/Interface:%20SBUserAvatar)
-
-___
-
-### department
-
-• `Optional` **department**: *string*
-
-___
-
-### firstName
-
-• **firstName**: *string*
-
-___
-
-### lastName
-
-• **lastName**: *string*
-
-___
-
-### location
-
-• `Optional` **location**: *string*
-
-___
-
-### phoneNumber
-
-• `Optional` **phoneNumber**: *string*
-
-___
-
-### position
-
-• `Optional` **position**: *string*
-
-___
-
-### publicEmailAddress
-
-• `Optional` **publicEmailAddress**: *string*

package/docs/Interface: UserListItem.md

@@ -1,27 +0,0 @@
-# Interface: UserListItem
-
-Single user item
-
-## Properties
-
-### entityType
-
-• `Optional` **entityType**: *string*
-
-___
-
-### firstName
-
-• `Optional` **firstName**: *string*
-
-___
-
-### id
-
-• `Optional` **id**: *string*
-
-___
-
-### lastName
-
-• `Optional` **lastName**: *string*

package/docs/Interface: UserListRequestQuery.md

@@ -1,27 +0,0 @@
-# Interface: UserListRequestQuery
-
-User list request parameters
-
-## Properties
-
-### filter
-
-• `Optional` **filter**: *string*
-
-___
-
-### limit
-
-• `Optional` **limit**: *number*
-
-___
-
-### offset
-
-• `Optional` **offset**: *number*
-
-___
-
-### sort
-
-• `Optional` **sort**: [*UserListSorting*](../wiki/Home#userlistsorting)

package/docs/Interface: UserListResponse.md

@@ -1,27 +0,0 @@
-# Interface: UserListResponse
-
-Responded user list
-
-## Properties
-
-### data
-
-• **data**: [*UserListItem*](../wiki/Interface:%20UserListItem)[]
-
-___
-
-### limit
-
-• **limit**: *number*
-
-___
-
-### offset
-
-• **offset**: *number*
-
-___
-
-### total
-
-• **total**: *number*

package/docs/Interface: WidgetApi.md

@@ -1,75 +0,0 @@
-# Interface: WidgetApi
-
-Widget API class.
-
-A class providing access to additional information about the Staffbase ecosystem for widgets.
-
-## Methods
-
-### getLegacyAppTheme
-
-▸ **getLegacyAppTheme**(): [*ColorTheme*](../wiki/Interface:%20ColorTheme)
-
-Call to retrieve the color theme of the app. Since this theme definitions
-are currently redesigned, this method is called legacy.
-
-**Returns:** [*ColorTheme*](../wiki/Interface:%20ColorTheme)
-
-An object containing the color theme data is returned.
-
-___
-
-### getUserInformation
-
-▸ **getUserInformation**(`userId?`: *string*): *Promise*<[*SBUserProfile*](../wiki/Interface:%20SBUserProfile)\>
-
-Call to retrieve the user profile of the current or a specific user.
-
-#### Parameters:
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `userId?` | *string* | User ID to lookup for; leave blank to retrieve current user |
-
-**Returns:** *Promise*<[*SBUserProfile*](../wiki/Interface:%20SBUserProfile)\>
-
-A promise containing the SBUserProfile is returned. In case of an error,
-the promise is rejected.
-
-___
-
-### getUserInformationByExternalId
-
-▸ **getUserInformationByExternalId**(`externalId`: *string*): *Promise*<[*SBUserProfile*](../wiki/Interface:%20SBUserProfile)\>
-
-Call to retrieve a user profile by its external ID.
-
-#### Parameters:
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `externalId` | *string* | An external ID of the user that shall be returned |
-
-**Returns:** *Promise*<[*SBUserProfile*](../wiki/Interface:%20SBUserProfile)\>
-
-A promise containing the SBUserProfile is returned. In case of an error,
-the promise is rejected.
-
-___
-
-### getUserList
-
-▸ **getUserList**(`query`: [*UserListRequestQuery*](../wiki/Interface:%20UserListRequestQuery)): *Promise*<[*UserListResponse*](../wiki/Interface:%20UserListResponse)\>
-
-Call to retrieve a list of users determined by the query object.
-
-#### Parameters:
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `query` | [*UserListRequestQuery*](../wiki/Interface:%20UserListRequestQuery) | Adjust limit, offset, filter, and sorting for the request |
-
-**Returns:** *Promise*<[*UserListResponse*](../wiki/Interface:%20UserListResponse)\>
-
-A promise containing the UserListResponse is returned. In case of an error,
-the promise is rejected.

package/lib/base-block.ts

@@ -1,110 +0,0 @@
-/*!
- * Copyright 2021, Staffbase GmbH and contributors.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *     http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * Base class for custom widgets.
- *
- * Should be used to extend other custom elements to render their content.
- * Provides common editing and render capabilities for Staffbase widgets.
- */
-export interface BaseBlock extends HTMLElement {
-  /**
-   * Called when the widget is rendered in a page.
-   * Override this method in order to display your widget contents.
-   *
-   * Default implementation is a noop.
-   *
-   * @param container an `HTMLElement` into which the contents of the widget should be rendered.
-   * Note that this does not necessarily have to be `this` since the base class might
-   * render a title, a div with a border, or other decorations.
-   */
-  renderBlock(container: HTMLElement): void;
-
-  /**
-   * Called when the widget is rendered in the WYSIWYG editor.
-   * override this method in order to display your widget preview.
-   *
-   * By default, the editor will display a generic placeholder
-   * with the widget name and icon.
-   *
-   * @param container an `HTMLElement` into which the contents of the widget should be rendered
-   * Note that this does not necessarily have to be `this` since the base class might
-   * render a title, a div with a border, or other decorations.
-   */
-  renderBlockInEditor(container: HTMLElement): void;
-
-  /**
-   * Called when the widget is unmounted from the DOM.
-   *
-   * Override this in order to implement your unmount logic.
-   *
-   * @param container an `HTMLElement` which was used previously to render the widget.
-   */
-  unmountBlock(container: HTMLElement): void;
-
-  /**
-   * Called when an attribute is changed.
-   *
-   * Override this in order to get notified about new attribute values.
-   *
-   * NOTE: There are attributes that are common to all widgets. They are handled
-   * inside the base block. Therefore, if you override this method, be sure to
-   * call `super.attributeChangedCallback()` inside your implementation, in
-   * order to let the base class know about the arguments that it might be interested in.
-   */
-  attributeChangedCallback(
-    attrName: string,
-    oldValue: string | undefined,
-    newValue: string | undefined
-  ): void;
-
-  /**
-   * Called after the dialog is closed and the attributes are set on the web component.
-   *
-   * Override this if the attributes are handled with a different logic then the default one.
-   *
-   * @param attributes A map of attributes, as defined in the block definition, which have the
-   * types from the form data
-   *
-   * NOTE: The default implementation turns every value in a string, except arrays and object, which
-   * are converted to base64 encoded data uris in the format `data:text/plain;base64,...`
-   */
-  parseConfig<T extends Record<string, any>>(attributes: T): Record<string, string>;
-
-  /**
-   * Called when the config dialog is opened. The dialog uses the parsed attributes, to fill
-   * the fields with the existing values.
-   *
-   * Uses the property blockDefinition.attributes to parse each indidividual attribute and
-   * returns it in the format, the configuration form needs. The common attributes are handled
-   * externally
-   *
-   * This method is the counter part of parseConfig, the this must be implemented, if parseConfig
-   * is overriden.
-   *
-   * NOTE: The default implementation converts every string to string, boolean or number and decodes
-   * and parses the data uris to the arrays and objects. Dates are remaining a string!
-   */
-  parseAttributes<T extends Record<string, any>>(): T;
-
-  /**
-   * The content language as defined in the hosting system. Should be used to provide
-   * the correct localization in the widget.
-   *
-   * NOTE: This is not necessarily the same as the UI language, which is defined by the browser.
-   * When a widget is added to a specific content, the content-language attribute gets automatically set
-   * to that language.
-   */
-  contentLanguage: string;
-
-}

package/lib/block-definition.ts

@@ -1,101 +0,0 @@
-/*!
- * Copyright 2021, Staffbase GmbH and contributors.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *     http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { BlockFactory } from "./block-factory";
-import { JSONSchema7 } from "json-schema";
-import {UiSchema} from '@rjsf/core';
-
-export interface BlockDefinition<Factory = BlockFactory> {
-  /**
-   * The tag name of the widget. It must be compatible with 
-   * webcomponent naming conventions.
-   *
-   * @see https://www.webcomponents.org/community/articles/how-should-i-name-my-element
-   */
-  name: string;
-
-  /**
-   * The implementation of the web component.
-   */
-  factory: Factory;
-
-  /**
-   * Can be used for extending from a built-in element.
-   */
-  options?: ElementDefinitionOptions;
-
-  /**
-   * DOM attributes of the element, must be in kebab-case.
-   */
-  attributes: string[];
-
-  /**
-   * Set to `inline` if you want the element to behave like a span element
-   * rather than a div element if not specified, it defaults to `block`.
-   */
-  blockLevel?: "block" | "inline";
-
-  /**
-   * Schema used for defining the configuration form.
-   *
-   * @example
-   * ```json
-   * {
-   *  "type": "object",
-   *  "required": [
-   *    "firstName",
-   *    "lastName"
-   *    ],
-   *  "properties": {
-   *    "firstName": {
-   *      "type": "string",
-   *      "title": "First name"
-   *      },
-   *  "lastName": {
-   *    "type": "string",
-   *    "title": "Last name"
-   *    }
-   *  }
-   * }
-   * ```
-   * @see https://react-jsonschema-form.readthedocs.io/en/latest/
-   */
-  configurationSchema: JSONSchema7;
-  
-  /**
-   *
-   * Schema to add more customization to the look and feel of the configuration form.
-   *
-   * ```json
-   * {
-   *   "firstName": {
-   *      "ui:help": "Your first name."
-   *   }
-   * }
-   * ```
-   *
-   * @see https://react-jsonschema-form.readthedocs.io/en/latest/api-reference/uiSchema/
-   */
-  uiSchema?: UiSchema;
-
-  /**
-   * Label displayed in the settings dialog and in the default widget preview.
-   */
-  label?: string;
-
-  /**
-   * Icon displayed on the widget installation page.
-   * We recommend an icon with the dimensions 32x32 px.
-   */
-  iconUrl?: string;
-}

package/lib/block-element.ts

@@ -1,56 +0,0 @@
-/*!
- * Copyright 2021, Staffbase GmbH and contributors.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *     http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export interface BlockElement {
-  /**
-   * Static getter to determine which HTML attributes should trigger the function 'attributeChangedCallback';
-   */
-  // readonly observedAttributes: string[];
-
-  /**
-   * Invoked when the custom element is first connected to the DOM.
-   */
-  connectedCallback: () => void;
-
-  /**
-   * Invoked when the custom element is disconnected from the DOM.
-   */
-  disconnectedCallback: () => void;
-
-  /**
-   * Invoked when the custom element is moved to a new document.
-   */
-  adoptedCallback: () => void;
-
-  /**
-   * Invoked when one of the attributes of the custom element is added, removed, or changed.
-   *
-   * Note that you have to statically register the observed values with the 'observedAttributes' static getter.
-   *
-   * @param attrName The changed attributes name
-   * @param oldValue The old value
-   * @param newValue The new value
-   */
-  attributeChangedCallback: (
-    attrName: string,
-    oldValue: string | undefined,
-    newValue: string | undefined
-  ) => void;
-
-  /**
-   * Method to unmount / revert any effects applied by rendering.
-   * E.g. to be used in editor cases to remove any rendered content
-   * and revert the block to its initial state.
-   */
-  unmount: () => void;
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "esnext",
-    "module": "commonjs",
-    "noEmit": true,
-
-    "strict": true,
-
-    "moduleResolution": "node",
-    "baseUrl": "./",
-    "esModuleInterop": true
-  }
-}